Get all coupon codes

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

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

A unique request ID.

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 generated using the create promotion endpoint.

Filter coupon codes generated using the generate coupon codes endpoint.

Filter coupon codes by their status

Filter coupon codes based on the start date of the coupon, in UTC format. startFrom and StartTo represent date range for the start date 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 start date 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 end date 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 end date 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

The pagination details.

An array containing coupon details.