FAfabric
Redemptions

Get all redemption details

Use this endpoint to retrieve a list of redemption records. You can filter the records using parameters, such as couponCode, userId, email, orderId, or storeId.

get/redemptions

Request

Query parameters

sizeinteger

The maximum number of records per page.

startCursorstring
Example:H796HJHGANLSADS

Specifies the record from which the search will start, effectively skipping all records before this point.

promotionIdstring
Example:62d172529da20e000924dfb5

Promotion ID for which you want to get the redemption records

couponCodestring
Example:BESTSUMMER

Coupon code for which you want to get the redemption records

userIdstring
Example:5f8b8b2a9da20e000924dfb5

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

emailstring
Example:guest@gmail.com

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

orderIdstring
Example:1590-2016-123456

Order ID associated with the redemption records

storeIdstring

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

status'ACTIVE' | 'INACTIVE'
Example:ACTIVE

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.
redeemedFromstring
Example:2023-10-18T19:00:51.459Z

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

redeemedTostring
Example:2023-11-18T19:00:51.459Z

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

updatedFromstring
Example:2023-10-18T19:00:51.459Z

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

updatedTostring
Example:2023-11-18T19:00:51.459Z

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

additionalAttributesstring
Example:{"name":"brand","values":"Nike"}

Additional attributes to filter redemption records

promotionAdditionalAttributesstring
Example:{"name":"WeboutletValid","values":"NO"}

Promotion-specific additional attributes to filter redemption records

promotionNamestring
Example:Summer promotion

Promotion name by which you want to filter the redemption records

isImplicitboolean

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.

singleMultiUse'SINGLE_USE' | 'MULTI_USE'
Example:SINGLE_USE

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

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

Example response

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

Changes

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