Skip to content
docs
ES
PromotionsCoupons

List coupons

Returns cursor-paginated coupons, filterable by status, type and target.

GET/v1/coupons
Requires an access token with the promotion:read permission.

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Cursor from the previous response. Omit it on the first page.

search?string

Free-text search.

sortBy?string

Field to sort by.

sortDirection?string

Sort direction: asc or desc.

Value in

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

Only items in these statuses.

Value in

  • "draft"
  • "active"
  • "scheduled"
  • "inactive"
  • "expired"
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://api.ecomiq.pe/api/v1/coupons" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004329139",      "storeId": "7204558912004327977",      "sellerId": "7204558912004323447",      "name": "Bienvenida 10 %",      "status": "draft",      "type": "percentage",      "target": "order",      "amount": 178,      "allocation": "once",      "maxQuantity": 2,      "applyAfterTaxes": false,      "isAutomatic": false,      "validFrom": "2026-09-28T15:30:00Z",      "validTo": "2026-09-28T15:30:00Z",      "usageLimit": 1,      "usageCount": 24,      "codeCount": 24,      "ruleCount": 24,      "customerUsageLimit": 1,      "combineWithOtherDiscounts": false,      "primaryCode": "POL-001",      "rules": [        {          "field": "cartSubtotal",          "operator": "eq",          "decimalValues": [            1          ],          "integerValues": [            1          ],          "resourceIds": [            "7204558912004324902"          ],          "codes": [            "BIENVENIDA10"          ]        }      ],      "createdOn": "2026-09-28T15:30:00Z",      "updatedOn": "2026-09-28T15:30:00Z"    }  ],  "hasNextPage": true,  "nextCursor": "eyJpZCI6IjcyMDQ1NTg5MTIwMDQzMjUzMDEifQ",  "totalCount": 24}