FAfabric
Redemption

Get redemption List

Enables you to get a paginated redemption list.

get/api-offers/redemptions

Request

Query parameters

sizenumber

The size of records per page.

startCursorstring nullable

The value for start cursor.

promoIdstring

The filter value for promoId.

promoCodestring

The filter value for promoCode.

userIdstring

The filter value for userId.

emailstring

The filter value for email.

orderIdstring

The filter value for orderId.

storeIdstring

The filter value for storeId.

status'ACTIVE' | 'INACTIVE'

The filter value for status.

redeemedFromstring date-time

The filter value for redeemedFrom.

redeemedTostring date-time

The filter value for redeemedTo.

updatedFromstring date-time

The filter value for updatedFrom.

updatedTostring date-time

The filter value for updatedTo.

titlestring

The filter value for title.

isImplicitboolean

The filter value for isImplicit.

singleMultiUse'MULTI_USE' | 'SINGLE_USE'

The filter value for singleMultiUse.

additionalAttributesstring

The filter value for additionalAttributes.

promoAdditionalAttributesstring

The filter value for promoAdditionalAttributes.

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Response

OK

Example response

{
  "query": {
    "limit": 10,
    "count": 150
  },
  "data": [
    {
      "_id": "614b58924e92f6861ac9d43b",
      "promoId": "614b58924e92f6861ac91234",
      "promoCode": "BESTSUMMER",
      "userId": "614b58924e92f61234567890",
      "email": "guest@gmail.com",
      "orderId": "1590-2016-12345",
      "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.