Skip to main content
GET
List stores

🏬 List Stores

This endpoint allows you to list all stores associated with your account. Stores are returned in position order (ascending). It is ideal for:
  • Displaying stores in administrative panels
  • Integrating data with other systems
  • Automating store queries

🔐 Authentication

This route requires authentication via API Key, sent in the request header:

📋 Example Request

📊 Example Response (200)

The first call (without cursor) already returns nextCursor and hasMore in the pagination, allowing cursor pagination to start without extra calls.

📌 Parameters

Query params

If there are no stores on the queried page, stores is returned as an empty array.

🔄 Cursor pagination

For large lists (more than ~100 items), prefer cursor pagination instead of page:
  1. Make the first call without cursor.
  2. If hasMore is true, the response includes the nextCursor field.
  3. Send that nextCursor in the cursor parameter of the next request to fetch the next page.
In cursor mode, pagination is returned only with nextCursor, hasMore and limit:
  • cursor and page cannot be used together (400 INVALID_PAGINATION).
  • nextCursor: null with hasMore: false indicate the end of the list (the API responds 200 with an empty array).

⚠️ Possible errors

  • 400 INVALID_PAGINATION_LIMIT → limit outside the allowed range (1 to 100)
  • 400 INVALID_PAGINATION_PAGE → invalid page
  • 400 INVALID_PAGINATION_CURSOR → invalid or malformed cursor
  • 400 INVALID_PAGINATION → page and cursor used together
  • 401 API_KEY_NOT_PROVIDED → Authorization header not sent
  • 401 INVALID_API_KEY → invalid or not found API Key
  • 401 UNAUTHENTICATED → session/user not authenticated
  • 403 USER_DISABLED → user account disabled or deleted
  • 403 NO_ACTIVE_SUBSCRIPTION → account has no active plan
  • 429 RATE_LIMIT_EXCEEDED → plan per-minute request limit exceeded
  • 500 INTERNAL_SERVER_ERROR → internal error
  • 503 SERVICE_UNAVAILABLE → service temporarily unavailable
Update: 23/05/2024 as 13:00

Authorizations

Authorization
string
header
default:YOUR_API_KEY_HERE
required

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

Opaque cursor from previous page (do not combine with page).

Response

Owner stores list ordered by position.

code
string
required
Example:

"SUCCESS"

pagination
object
required
stores
object[]
required