Skip to content
ShopAssist Docs
APIAPI referenceStores

List Stores

Stores of the key's organization (only store_ids for restricted keys).

GET/v1/storesScope stores:read

Stores of the key's organization (only `store_ids` for restricted keys).

Parameters

Parameters of List Stores
NameInTypeDescription
limitqueryintegerPage size
cursorquerystring | nullCursor from the previous page

Example request

curl -X GET "https://api.shopassist.coec.dk/v1/stores" \
  -H "Authorization: Bearer $SHOPASSIST_API_KEY"

Response 200 (Page_StorePublic_)

Response of List Stores
FieldTypeDescription
datarequiredStorePublic[]
data[].capabilitiesrequiredobjectstores.capabilities (02 §17)
data[].catalog_localerequiredstring2–35 characters · pattern `^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$`
data[].created_atrequiredstringformat date-time
data[].currencyrequiredstringpattern `^[A-Z]{3}$`
data[].idrequiredstringpattern `^sto_[0-9a-hjkmnp-tv-z]{26}$`
data[].namerequiredstring
data[].platformrequired"shopify" | "magento2" | "woocommerce" | "prestashop" | "generic"
data[].primary_domainrequiredstring | null
data[].statusrequiredstring (enum)one of pending_connect, connecting, syncing, active, paused, reconnect_required, disconnected, uninstalled, suspended
data[].timezonerequiredstring
has_morerequiredboolean
next_cursorrequiredstring | nullOpaque cursor for the next page; null on the last page
{
  "data": [
    {
      "capabilities": {},
      "catalog_locale": "da-DK",
      "created_at": "2026-09-28T10:15:30.123Z",
      "currency": "DKK",
      "id": "sto_01j8000000e008000000000000",
      "name": "string",
      "platform": "shopify",
      "primary_domain": "string",
      "status": "pending_connect",
      "timezone": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Errors

Every error uses the error envelope; the code field is stable.

  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 422 Unprocessable Content
  • 429 Too Many Requests

Last updated on