FAfabric
Redemptions

Get redemption by ID

Retrieves a specific redemption using the corresponding redemptionId value.

get/redemptions/{redemptionId}

Request

Path parameters

redemptionIdstring required
Example:614b58924e92f6861ac9d43b

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

  • Create redemption
  • Create redemption using coupon ID

Headers

x-fabric-tenant-idstring 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.

x-fabric-channel-idstring
Example:12

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-idstring

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

x-fabric-request-idstring
Example:263e731c-45c8-11ed-b878-0242ac120002

A unique request ID.

Response

OK

idstring required

System-generated redemption ID

promotionIdstring required

ID of the promotion to which the coupon code belongs

couponCodestring

Redeemed coupon code

orderIdstring required

Purchase order ID associated with the redemption

userIdstring nullable

ID of the user who redeems the coupon

emailstring nullable

Email address of the user who redeems the coupon

storeIdstring

ID of the store where the coupon is redeemed

redeemedAtstring date-time

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

status'INACTIVE' | 'ACTIVE'

The following are redemption statuses:

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

Promotion name by which you want to filter the redemption records

createdAtstring date-time required

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

updatedAtstring date-time required

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

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.