GET
/
coupon-codes

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

Merchant's 24-character tenant ID

x-fabric-channel-id
string

The sales channel ID.

x-client-id
string

The platform where the request is made.

x-fabric-request-id
string

A unique request ID.

Query Parameters

size
integer
default: 10

The maximum number of records per page.

startCursor
string

Specifies the record from which the search will start, effectively skipping all records before this point.

userId
string

Filter coupon codes by user ID

promotionId
string

Filter coupon codes by promotion ID

couponCode
string

Filter coupon codes by coupon code

status
enum<string>

Filter coupon codes by their status

Available options:
ACTIVE,
INACTIVE,
REDEEMED
startFrom
string

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'

startTo
string

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'

endFrom
string

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'

endTo
string

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'

additionalAttributes
string

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.

promotionAdditionalAttributes
string

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.

title
string

Filter coupon codes by promotion title

Response

200 - application/json
query
object

The pagination details.

data
object[]

Coupon codes list.