Get all coupon codes
This endpoint provides coupon code lists. Use parameters to filter results, for example, set status as ‘ACTIVE’ for active coupons, or add userId for user-specific coupon codes. Navigate the results using the query parameters size
and startCursor
.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Merchant's 24-character tenant ID
The sales channel ID.
The platform where the request is made.
A unique request ID.
Query Parameters
The maximum number of records per page.
Specifies the record from which the search will start, effectively skipping all records before this point.
Filter coupon codes by user ID
Filter coupon codes by promotion ID
Filter coupon codes by coupon code
Filter coupon codes by their status
ACTIVE
, INACTIVE
, REDEEMED
Filter coupon codes based on the start date of the coupon, in UTC format. startFrom
and StartTo
represent date range for the startDate of the coupon code. For example, you can find coupon codes where start date is from '2023-03-01T01:14:50.967Z' to '2023-03-10T01:14:50.967Z'
Filter coupon codes based on the start date of the coupon, in UTC format. startFrom
and StartTo
represent date range for the startDate of the coupon code. For example, you can find coupon codes where start date is from '2023-03-01T01:14:50.967Z' to '2023-03-10T01:14:50.967Z'
Filter coupon codes based on the end date of the coupon, in UTC format. endFrom
and endTo
represent date range for the endDate of the coupon code. For example, you can find coupon codes where end date is from '2023-04-01T01:14:50.967Z' to '2023-04-10T01:14:50.967Z'
Filter coupon codes based on the end date of coupon, in UTC format. endFrom
and endTo
represent date range for the endDate of the coupon code. For example, you can find coupon codes where end date is from '2023-04-01T01:14:50.967Z' to '2023-04-10T01:14:50.967Z'
Filter coupon codes by additional attributes. <br> This filter needs to be a valid JSON array and name:values
pairs to be able to make the search.
Filter coupon codes by supplementary attributes of a promotion.<br> This filter needs to be a valid JSON array and name:values
pairs to be able to make the search.
Filter coupon codes by promotion title
Response
The pagination details.
Coupon codes list.
Was this page helpful?