Skip to main content
GET
List coupons

📌 Endpoint

GET /stores/{storeId}/coupons Lists the store coupons (not expired). Coupons are returned in position order (ascending).

🔐 Authentication

  • Private route.
  • Requires header Authorization with your API key and active plan.

🧾 Route parameters


✅ Example request


🔎 Query params


🔄 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 (only cursor mode responds 200 with an empty array []; offset mode with page returns 404 COUPONS_NOT_FOUND when total is 0).

Standard snippet (cURL)

Use the cURL example from the Request example section above as the official snippet.

📦 Success response (200)

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

⚠️ Possible errors

  • 400 INVALID_DATA → invalid parameters
  • 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 provided
  • 401 INVALID_API_KEY → invalid API key
  • 401 UNAUTHENTICATED → unauthenticated user
  • 403 USER_DISABLED → user disabled
  • 403 NO_ACTIVE_SUBSCRIPTION → no active plan
  • 404 STORE_NOT_FOUND → store not found
  • 404 COUPONS_NOT_FOUND → no coupons found (returned in offset mode when total is 0; only cursor mode returns 200 with [])
  • 429 RATE_LIMIT_EXCEEDED → per-minute rate limit exceeded
  • 500 INTERNAL_SERVER_ERROR → internal error
  • 503 SERVICE_UNAVAILABLE → service unavailable

Authorizations

Authorization
string
header
default:YOUR_API_KEY_HERE
required

Path Parameters

storeId
string
required
Required string length: 1 - 50

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

List coupons.

code
string
required
Example:

"COUPONS_FETCHED"

coupons
object[]
required
pagination
object
required