PUT
/
redemptions
/
{redemptionId}

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

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.

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

Path Parameters

​
redemptionId
string
required

Redemption ID to update the redemption. The redemption ID generated using the following endpoints:

Body

application/json

Redemption details

​
promotionId
required

ID of the promotion to which the coupon code belongs

​
orderId
string
required

Purchase order ID associated with the redemption

​
couponCode
string

Coupon code to be redeemed

​
userId
string | null

ID of the user who redeems the coupon

​
email
string | null

Email address of the user who redeems the coupon

​
storeId
string | null

ID of the store where the coupon is redeemed

​
redeemedAt
string | null

The timestamp in UTC format for when the coupon was redeemed.

​
additionalAttributes
object[]

Merchant-specified attributes associated with the redemption

​
status
enum<string>

The following are redemption statuses:

  • ACTIVE: Represents created redemption records.
  • INACTIVE: Represents redemption records that were created but became inactive due to order cancellation.
Available options:
INACTIVE,
ACTIVE

Response

200 - application/json

Coupon's redemption details

​
id
string
required

System-generated redemption ID

​
promotionId
string
required

ID of the promotion to which the coupon code belongs

​
orderId
string
required

Purchase order ID associated with the redemption

​
createdAt
string
required

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

​
updatedAt
string
required

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

​
couponCode
string

Redeemed coupon code

​
userId
string | null

ID of the user who redeems the coupon

​
email
string | null

Email address of the user who redeems the coupon

​
storeId
string

ID of the store where the coupon is redeemed

​
redeemedAt
string

The timestamp in UTC format for when the coupon was redeemed.

​
status
enum<string>

The following are redemption statuses:

  • ACTIVE: Represents created redemption records.
  • INACTIVE: Represents redemption records that were created but became inactive due to order cancellation.
Available options:
INACTIVE,
ACTIVE
​
additionalAttributes
object[]

Merchant-specified attributes associated with the redemption

​
promotionAdditionalAttributes
object[]

Merchant-specified attributes associated with the related promotion. This value is automatically populated according to the attributes of the related promotion.

​
promotionName
string

Promotion name by which you want to filter the redemption records

Was this page helpful?

Get redemption by IDBulk update redemptions