API reference

Store

The store the API key belongs to.

Get the store

get/store

Required scopes:read_store

Example request

curl

curl "https://api.sellorchard.com/v1/store" \
  -H "Authorization: Bearer $SELLORCHARD_API_KEY"

Response200The store.

Show response schema

dataStorerequired
ShowHide child attributes
- objectstringrequired
- idstringrequired
  The store id (a ULID).
- namestringrequired
  Store name.
- handlestringrequired
  The store address on SellOrchard.
- domainstringrequired
  The storefront hostname (primary domain).
- emailstring<email> | nullrequired
  Contact email.
- phonestring | nullrequired
  Contact phone.
- addressAddress | any | nullrequired
  The store address.
  ShowHide child attributes
  One of the following:
  Address
  first_namestring | null
  First name.
  last_namestring | null
  Last name.
  companystring | null
  Company.
  line1string | null
  Line1.
  line2string | null
  Line2.
  citystring | null
  City.
  regionstring | null
  Region.
  postcodestring | null
  Postcode.
  countrystring | null
  ISO 3166-1 alpha-2 country code.
  phonestring | null
  Phone.
  any | null
- currencystringrequired
  ISO 4217 store currency; every amount is in it unless an object says otherwise.
- timezonestringrequired
  IANA time zone (reports use it).
- statusstringrequired
  Store status.
  One of:trialactivepast_duesuspendedcancelledinactive
- planstring | nullrequired
  Plan key.
- test_modebooleanrequired
  Free-trial stores: orders are test orders and keys start with so_test_.
- created_atstring<date-time>required
  When the store was created.

200 response

{
  "data": {
    "object": "store",
    "id": "01JD4Z8T6Q2W9X5V3B7N1M0K8H",
    "name": "Orchard Goods",
    "handle": "orchard-goods",
    "domain": "shop.orchardgoods.com",
    "email": "hello@orchardgoods.com",
    "phone": null,
    "address": {
      "first_name": null,
      "last_name": null,
      "company": null,
      "line1": "1 Main St",
      "line2": null,
      "city": "Austin",
      "region": "TX",
      "postcode": "73301",
      "country": "US",
      "phone": null
    },
    "currency": "USD",
    "timezone": "America/Chicago",
    "status": "active",
    "plan": "pro",
    "test_mode": false,
    "created_at": "2026-11-02T15:00:00Z"
  }
}

Error responses

401authenticationMissing, invalid, expired or revoked API key.
403permissionThe key lacks the scope, or the store's plan doesn't include the API.
429rate_limitedToo many requests.
500serverSomething went wrong on our side; safe to retry with the same Idempotency-Key.