Skip to main content
POST
/
coupons
/
{couponId}
/
redemptions
Create redemption
curl --request POST \
  --url https://api.fabric.inc/v3/coupons/{couponId}/redemptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "couponCode": "BESTSUMMER",
  "orderId": "1590-2016-12345-7897",
  "userId": "614b58924e92f61234567890",
  "email": "[email protected]"
}
'
{
  "id": "614b58924e92f6861ac9d43b",
  "couponId": "614b58924e92f6861ac91234",
  "couponCode": "BESTSUMMER",
  "orderId": "1590-2016-12345",
  "userId": "614b58924e92f61234567890",
  "email": "[email protected]",
  "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"

Path Parameters

​
couponId
string
required

A 24-character system-generated coupon ID generated using the create coupon endpoint.

Example:

"614b58924e92f6861ac9d43b"

Body

application/json

Coupon redemption details

​
couponCode
string
required

Coupon code to be redeemed

Example:

"BESTSUMMER"

​
orderId
string
required

Purchase order ID associated with the coupon redemption

Example:

"1590-2016-12345-7897"

​
userId
string | null

ID of the user who redeems the coupon

Example:

"614b58924e92f61234567890"

​
email
string | null

Email address of the user who redeems the coupon

Example:

"[email protected]"

Response

Created

Coupon's redemption details

​
id
string
required

A 24-character system-generated redemption ID.

Example:

"614b58924e92f6861ac9d43b"

​
couponId
string
required

A 24-character system-generated coupon ID generated using the create coupon endpoint.

Example:

"614b58924e92f6861ac91234"

​
couponCode
string
required

Coupon code to redeem

Example:

"BESTSUMMER"

​
orderId
string
required

Purchase order ID associated with the coupon redemption

Example:

"1590-2016-12345"

​
userId
string

ID of the user who redeems the coupon

Example:

"614b58924e92f61234567890"

​
email
string | null

Email address of the user who redeems the coupon

Example:

"[email protected]"

​
createdAt
string<date-time>

The timestamp in UTC format of when the coupon redemption was created.

Example:

"2020-12-14T12:15:43.646Z"

​
updatedAt
string<date-time>

The timestamp in UTC format of when the coupon redemption was last updated.

Example:

"2021-12-14T12:15:43.646Z"