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

Merchant's 24-character tenant ID

x-fabric-channel-id
string

The sales channel ID.

x-client-id
string

The platform where the request is made.

x-fabric-request-id
string

A unique request ID.

Path Parameters

redemptionId
string
required

Redemption ID to update the redemption

Body

application/json
promotionId
required

ID of the promotion to which the coupon code belongs

couponCode
string

Coupon code to be redeemed

orderId
string
required

Purchase order ID associated with the redemption

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

Redemption time

additionalAttributes
object[]

Merchant-specified attributes associated with the redemption

status
enum<string>

Redemption status. The options are:<br>ACTIVE: Represents created redemption records.<br>INACTIVE: Represents redemption records that are created, but became inactive due to order cancellation.

Available options:
INACTIVE,
ACTIVE

Response

200 - application/json
id
string
required

System-generated redemption ID

promotionId
string
required

ID of the promotion to which the coupon code belongs

couponCode
string

Redeemed coupon code

orderId
string
required

Purchase order ID associated with the redemption

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

Redemption time

status
enum<string>

Redemption status. The options are:<br>ACTIVE: Represents created redemption records.<br>INACTIVE: Represents redemption records that are 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

createdAt
string
required

Redemption's creation time

updatedAt
string
required

Redemption's last updated time

Was this page helpful?

Get redemption by IDBulk update redemptions