Skip to content
Guides
ES
API reference
stablepromotion:read

List coupons

GET/v1/coupons

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<>
type?string

Value in

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

Value in

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

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"
{  "data": [    {      "id": "string",      "storeId": "string",      "sellerId": null,      "name": "string",      "status": "draft",      "type": "percentage",      "target": "order",      "amount": 0.1,      "allocation": "once",      "maxQuantity": null,      "applyAfterTaxes": true,      "isAutomatic": true,      "validFrom": null,      "validTo": null,      "usageLimit": null,      "usageCount": 0,      "codeCount": 0,      "ruleCount": 0,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}