Skip to content
docs
Guides
ES
PromotionsCoupons
promotion:read

List coupons

GET/v1/coupons

List coupons. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
status?array<>

Only items in these statuses.

type?string

Only this type.

Value in

  • "percentage"
  • "fixedAmount"
  • "freeShipping"
  • "buyXGetY"
target?string

Value in

  • "order"
  • "item"
  • "shipping"

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/coupons" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "sellerId": "7204558912004325301",      "name": "Example resource",      "status": "draft",      "type": "percentage",      "target": "order",      "amount": 1,      "allocation": "once",      "maxQuantity": 1,      "applyAfterTaxes": false,      "isAutomatic": false,      "validFrom": "2026-08-01T15:30:00Z",      "validTo": "2026-08-01T15:30:00Z",      "usageLimit": 1,      "usageCount": 1,      "codeCount": 1,      "ruleCount": 1,      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}