Coupons
List Coupons
Learn how to list coupons from a store using the endpoint GET /stores//coupons.
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
Authorizationwith 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 ofpage:
- Make the first call without
cursor. - If
hasMoreistrue, the response includes thenextCursorfield. - Send that
nextCursorin thecursorparameter of the next request to fetch the next page.
nextCursor, hasMore and limit:
cursorandpagecannot be used together (400 INVALID_PAGINATION).nextCursor: nullwithhasMore: falseindicate the end of the list (only cursor mode responds200with an empty array[]; offset mode withpagereturns404 COUPONS_NOT_FOUNDwhen total is0).
Standard snippet (cURL)
Use the cURL example from the Request example section above as the official snippet.📦 Success response (200)
The first call (withoutcursor) already returnsnextCursorandhasMorein the pagination, allowing cursor pagination to start without extra calls.
⚠️ Possible errors
400 INVALID_DATA→ invalid parameters400 INVALID_PAGINATION_LIMIT→limitoutside the allowed range (1to100)400 INVALID_PAGINATION_PAGE→ invalidpage400 INVALID_PAGINATION_CURSOR→ invalid or malformedcursor400 INVALID_PAGINATION→pageandcursorused together401 API_KEY_NOT_PROVIDED→Authorizationheader not provided401 INVALID_API_KEY→ invalid API key401 UNAUTHENTICATED→ unauthenticated user403 USER_DISABLED→ user disabled403 NO_ACTIVE_SUBSCRIPTION→ no active plan404 STORE_NOT_FOUND→ store not found404 COUPONS_NOT_FOUND→ no coupons found (returned in offset mode when total is0; only cursor mode returns200with[])429 RATE_LIMIT_EXCEEDED→ per-minute rate limit exceeded500 INTERNAL_SERVER_ERROR→ internal error503 SERVICE_UNAVAILABLE→ service unavailable