Skip to main content
GET
/
coupon-codes
Get all coupon codes
curl --request GET \
  --url https://api.fabric.inc/v3/coupon-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "query": {
    "size": 10,
    "nextCursor": "H796HJHGANLSADS"
  },
  "data": [
    {
      "id": "641cf99d2de161c5a6d7a481",
      "title": "Summer coupons",
      "userId": "5e2cfb9b45570b000864c4b5",
      "couponCode": "SUMMER",
      "versionId": 3,
      "promotionId": "641cf986ca5b2c3180787e05",
      "startAt": "2023-08-10T19:00:00.000Z",
      "endAt": "2023-08-10T09:10:57.811Z",
      "status": "ACTIVE",
      "additionalAttributes": [
        {
          "name": "brand",
          "values": "2"
        }
      ],
      "promotionAdditionalAttributes": [
        {
          "name": "eventName",
          "values": "Store sale"
        }
      ],
      "createdAt": "2019-08-20T14:15:22.000Z",
      "updatedAt": "2019-08-20T14:15:22.000Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-fabric-tenant-id
string
required

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.

Required string length: 24
​
x-fabric-channel-id
string

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.

Example:

"12"

​
x-client-id
string

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

​
x-fabric-request-id
string

A unique request ID.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Query Parameters

​
size
integer
default:10

The maximum number of records per page.

Required range: 1 <= x <= 100
​
startCursor
string

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

Maximum length: 1000
Example:

"H796HJHGANLSADS"

​
userId
string

Filter coupon codes by user ID

Example:

"user0001"

​
promotionId
string

Filter coupon codes by promotion ID generated using the create promotion endpoint.

Example:

"641cf986ca5b2c3180787e09"

​
couponCode
string

Filter coupon codes generated using the generate coupon codes endpoint.

Example:

"SUMMER"

​
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 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'

Example:

"2023-03-24T01: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 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'

Example:

"2023-03-24T01: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 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'

Example:

"2023-04-24T01: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 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'

Example:

"2023-03-24T01: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.

Example:

"[{\"name\":\"brand\",\"values\":\"123\"}]"

​
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.

Example:

"[{\"name\":\"type\",\"values\":\"Holiday\"}]"

​
title
string

Filter coupon codes by promotion title

Example:

"Summer promotion"

Response

OK

The paginated response of coupon codes.

​
query
object

The pagination details.

​
data
object[]

An array containing coupon details.