GET
/
redemptions
curl --request GET \
  --url https://api.fabric.inc/v3/redemptions \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "query": {
    "size": 10,
    "nextCursor": "H796HJHGANLSADS"
  },
  "data": [
    {
      "id": "614b58924e92f6861ac9d43b",
      "promotionId": "614b58924e92f6861ac91234",
      "couponCode": "BESTSUMMER",
      "orderId": "1590-2016-12345",
      "userId": "614b58924e92f61234567890",
      "email": "guest@example.com",
      "storeId": "A-100001",
      "redeemedAt": "2020-12-14T12:15:43.646Z",
      "status": "ACTIVE",
      "additionalAttributes": [
        {
          "name": "brand",
          "values": "Nike"
        }
      ],
      "promotionAdditionalAttributes": [
        {
          "name": "eventName",
          "values": "Store sale"
        }
      ],
      "promotionName": "Summer promotion",
      "createdAt": "2020-12-14T12:15:43.646Z",
      "updatedAt": "2021-12-14T12:15:43.646Z"
    }
  ]
}

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"

​
promotionId
string

Promotion ID for which you want to get the redemption records

Example:

"62d172529da20e000924dfb5"

​
couponCode
string

Coupon code for which you want to get the redemption records

Example:

"BESTSUMMER"

​
userId
string

ID of the user for whom you want to get the redemption records

Example:

"5f8b8b2a9da20e000924dfb5"

​
email
string

Email address of the user for whom you want to get the redemption records

Example:

"guest@gmail.com"

​
orderId
string

Order ID associated with the redemption records

Example:

"1590-2016-123456"

​
storeId
string

Comma-separated IDs of the stores for which you want to get the redemption records

Example:

10001

​
status
enum<string>

Status by which you want to filter the redemption records. The options are:

  • ACTIVE: Refers to the created redemption records.
  • INACTIVE: Refers to the redemption records that were generated but are inactive due to order cancellations.
Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
redeemedFrom
string

If specified, it returns the redemption records that are created from this specific date

Example:

"2023-10-18T19:00:51.459Z"

​
redeemedTo
string

If specified, it returns the created redemption records till this specific date

Example:

"2023-11-18T19:00:51.459Z"

​
updatedFrom
string

If specified, it returns the redemption records that are updated from this specific date

Example:

"2023-10-18T19:00:51.459Z"

​
updatedTo
string

If specified, it returns the updated redemption records till this specific date

Example:

"2023-11-18T19:00:51.459Z"

​
additionalAttributes
string

Additional attributes to filter redemption records

Example:

"{\"name\":\"brand\",\"values\":\"Nike\"}"

​
promotionAdditionalAttributes
string

Promotion-specific additional attributes to filter redemption records

Example:

"{\"name\":\"WeboutletValid\",\"values\":\"NO\"}"

​
promotionName
string

Promotion name by which you want to filter the redemption records

Example:

"Summer promotion"

​
isImplicit
boolean

This boolean query parameter is used to filter for redemptions associated with either implicit or non-implicit promotions. If the filter isn't provided, the response will include all redemptions.

Example:

false

​
singleMultiUse
enum<string>

Filter that indicates if the redemptions will belong to SINGLE or MULTI use coupon. If not sent, all redemptions will be returned.

Available options:
SINGLE_USE,
MULTI_USE
Example:

"SINGLE_USE"

Response

200
application/json

OK

Redemption information