This endpoint retrieves details for all cart promotions redeemed by customers.

Example request

curl --location 'https://{eu}/api_gateway/v1/promotions/redemptions' \
--header 'Authorization: Basic Z2VvcmdlLmJ1a2w6NzYzNDkxGQ3YzI4ZjU4ZjY3MmNhZjY1ZmY=' \
--header 'Cookie: _cfuvid=9uXeNm9Lv0qt_Ru_K6mNKs_c0mz0QPE98-1762146331879-0.0.1.1-604800000'

Prerequisites

Authentication: Basic or OAuth authentication.
Default access group

Resource information


Pagination	Yes
Batch support	No

Rate limit

Demo and Testing Clusters: 1,000 requests per minute per API key
Other Organizations: The rate limit is brand-specific.

To modify the limit, create a ticket with the Capillary Product support team.

Query parameters

Field	Type	Required	Description
customerId	Number	Optional	Filters the cart promotion redemptions by customer ID.
promotionId	String	Optional	Filters the cart promotion redemptions by cart promotion ID.
transactionIdentifier	String	Optional	Filters the cart promotion redemptions by the unique transaction identifier.
transactionEntityIdentifier	String	Optional	Filters the cart promotion redemptions by transaction entity identifier.
mode	String	Optional	Filter by cart promotion mode. Supported values : `DISCOUNT`, `PAYMENT_VOUCHER`.
limit	Number	Optional	Maximum number of records to return. The default is 10.
pageNumber	Number	Optional	Page number for pagination (starts from 0). The default is 0.
sortOn	String	Optional	This parameter lets you sort based on the Enum: `REDEMPTION_DATE`.
order	String	Optional	Sort order. Enum: ASC, DESC. Default : DESC

Example response

{
    "data": [
        {
            "id": "68b827c47880ba5aa7cf6ecc",
            "orgId": 100458,
            "promotionId": "6880c210d9234a5350ca4b05",
            "customerId": 174193742,
            "redemptionDate": 1756899268000,
            "redemptionDateISO": "2025-09-03T11:34:28Z",
            "transactionIdentifier": "890772441",
            "transactionNumber": "TX50116778016",
            "promotionName": "20% off on Cart",
            "promotionMessageLabel": "20% off on Cart",
            "transactionEntityIdentifier": "REGULAR_b_890772441",
            "cartEvaluationId": "68b827bdaa0d7a770cbab2e3",
            "redemptionTill": 75036445,
            "discount": "15980.000000",
            "redemptionCount": 1,
            "amount": "63920.000000",
            "redemptionType": "CART"
        },
        {
            "id": "689593b66762432a0d914ae7",
            "orgId": 100458,
            "promotionId": "6864d72be0b885544103a034",
            "customerId": 566039596,
            "redemptionDate": 1754635874000,
            "redemptionDateISO": "2025-08-08T06:51:14Z",
            "transactionIdentifier": "889714547",
            "transactionNumber": "TXN930251596",
            "promotionName": "Buy 1 get 1 offer",
            "promotionMessageLabel": "Buy 1 get 1 offer",
            "transactionEntityIdentifier": "REGULAR_l_4024868103",
            "cartEvaluationId": "689593450484736895ddd503",
            "redemptionTill": 75175597,
            "discount": "6999.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "1.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "13992.000000",
            "sku": "FMPM39646401",
            "redemptionType": "LINEITEM",
            "productId": 501799045
        },
        {
            "id": "689593b66762432a0d914ae6",
            "orgId": 100458,
            "promotionId": "6864d72be0b885544103a034",
            "customerId": 566039596,
            "redemptionDate": 1754635874000,
            "redemptionDateISO": "2025-08-08T06:51:14Z",
            "transactionIdentifier": "889714547",
            "transactionNumber": "TXN930251596",
            "promotionName": "Buy 1 get 1 offer",
            "promotionMessageLabel": "Buy 1 get 1 offer",
            "transactionEntityIdentifier": "REGULAR_l_4024868103",
            "cartEvaluationId": "689593450484736895ddd503",
            "redemptionTill": 75175597,
            "discount": "0.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "0.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "13992.000000",
            "sku": "FMPM39646401",
            "redemptionType": "LINEITEM",
            "productId": 501799045
        },
        {
            "id": "6881b482d9234a5350ca5212",
            "orgId": 100458,
            "promotionId": "6880c4c8d9234a5350ca4b06",
            "customerId": 566053792,
            "redemptionDate": 1753333542000,
            "redemptionDateISO": "2025-07-24T05:05:42Z",
            "transactionIdentifier": "889082818",
            "transactionNumber": "TXN414963842",
            "promotionName": "Buy 1 get 1",
            "promotionMessageLabel": "Buy 1 get 1",
            "transactionEntityIdentifier": "REGULAR_l_4022552224",
            "cartEvaluationId": "6881b4792420517ca07cba52",
            "redemptionTill": 75175844,
            "discount": "0.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "0.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "989.000000",
            "sku": "32753189",
            "redemptionType": "LINEITEM",
            "productId": 501856374
        },
        {
            "id": "6881b482d9234a5350ca5213",
            "orgId": 100458,
            "promotionId": "6880c4c8d9234a5350ca4b06",
            "customerId": 566053792,
            "redemptionDate": 1753333542000,
            "redemptionDateISO": "2025-07-24T05:05:42Z",
            "transactionIdentifier": "889082818",
            "transactionNumber": "TXN414963842",
            "promotionName": "Buy 1 get 1",
            "promotionMessageLabel": "Buy 1 get 1",
            "transactionEntityIdentifier": "REGULAR_l_4022552224",
            "cartEvaluationId": "6881b4792420517ca07cba52",
            "redemptionTill": 75175844,
            "discount": "989.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "1.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "989.000000",
            "sku": "32753189",
            "redemptionType": "LINEITEM",
            "productId": 501856374
        },
        {
            "id": "6880cff7d9234a5350ca4bb5",
            "orgId": 100458,
            "promotionId": "6880c4c8d9234a5350ca4b06",
            "customerId": 121764125,
            "redemptionDate": 1753275035000,
            "redemptionDateISO": "2025-07-23T12:50:35Z",
            "transactionIdentifier": "889059071",
            "transactionNumber": "TXN696106512",
            "promotionName": "Buy 1 get 1",
            "promotionMessageLabel": "Buy 1 get 1",
            "transactionEntityIdentifier": "REGULAR_l_4022465655",
            "cartEvaluationId": "6880cff1d9234a5350ca4bb2",
            "redemptionTill": 75175844,
            "discount": "0.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "0.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "989.000000",
            "sku": "32753189",
            "redemptionType": "LINEITEM",
            "productId": 501856374
        },
        {
            "id": "6880cff7d9234a5350ca4bb6",
            "orgId": 100458,
            "promotionId": "6880c4c8d9234a5350ca4b06",
            "customerId": 121764125,
            "redemptionDate": 1753275035000,
            "redemptionDateISO": "2025-07-23T12:50:35Z",
            "transactionIdentifier": "889059071",
            "transactionNumber": "TXN696106512",
            "promotionName": "Buy 1 get 1",
            "promotionMessageLabel": "Buy 1 get 1",
            "transactionEntityIdentifier": "REGULAR_l_4022465655",
            "cartEvaluationId": "6880cff1d9234a5350ca4bb2",
            "redemptionTill": 75175844,
            "discount": "989.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "1.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "989.000000",
            "sku": "32753189",
            "redemptionType": "LINEITEM",
            "productId": 501856374
        },
        {
            "id": "6880c6952420517ca07cb4ea",
            "orgId": 100458,
            "promotionId": "6880c4c8d9234a5350ca4b06",
            "customerId": 121764125,
            "redemptionDate": 1753272632000,
            "redemptionDateISO": "2025-07-23T12:10:32Z",
            "transactionIdentifier": "889058387",
            "transactionNumber": "TXN913746843",
            "promotionName": "Buy 1 get 1",
            "promotionMessageLabel": "Buy 1 get 1",
            "transactionEntityIdentifier": "REGULAR_l_4022463398",
            "cartEvaluationId": "6880c671d9234a5350ca4b1e",
            "redemptionTill": 75175844,
            "discount": "989.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "1.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "989.000000",
            "sku": "32753189",
            "redemptionType": "LINEITEM",
            "productId": 501856374
        },
        {
            "id": "6880c6952420517ca07cb4eb",
            "orgId": 100458,
            "promotionId": "6880c4c8d9234a5350ca4b06",
            "customerId": 121764125,
            "redemptionDate": 1753272632000,
            "redemptionDateISO": "2025-07-23T12:10:32Z",
            "transactionIdentifier": "889058387",
            "transactionNumber": "TXN913746843",
            "promotionName": "Buy 1 get 1",
            "promotionMessageLabel": "Buy 1 get 1",
            "transactionEntityIdentifier": "REGULAR_l_4022463398",
            "cartEvaluationId": "6880c671d9234a5350ca4b1e",
            "redemptionTill": 75175844,
            "discount": "0.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "0.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "989.000000",
            "sku": "32753189",
            "redemptionType": "LINEITEM",
            "productId": 501856374
        },
        {
            "id": "686791feee52f074465e1b1e",
            "orgId": 100458,
            "promotionId": "6864d72be0b885544103a034",
            "customerId": 566053350,
            "redemptionDate": 1751620758000,
            "redemptionDateISO": "2025-07-04T09:19:18Z",
            "transactionIdentifier": "888360925",
            "transactionNumber": "TXN212177742",
            "promotionName": "Buy 1 get 1 offer",
            "promotionMessageLabel": "Buy 1 get 1 offer",
            "transactionEntityIdentifier": "REGULAR_l_4019994969",
            "cartEvaluationId": "686791f8ee52f074465e1b1c",
            "redemptionTill": 75036445,
            "discount": "0.000000",
            "redemptionCount": 1,
            "discountAppliedQuantity": "0.000000",
            "promotionAppliedQuantity": "1.000000",
            "amount": "6999.000000",
            "sku": "FMPM39646401",
            "redemptionType": "LINEITEM",
            "productId": 501799045
        }
    ],
    "errors": []
}

Response parameters

Field	Type	Description
data	Array	Defines a list of cart promotion redemption objects.
..id	String	Specifies the unique identifier for the redemption record.
..orgId	Number	Specifies the Organization ID.
..promotionId	String	Specifies the ID of the cart promotion that was redeemed.
..customerId	Number	Specifies the customer who redeemed the cart promotion.
..redemptionDate	Number	Indicates the timestamp of when the redemption was recorded in UTC.
..redemptionDateISO	String	Specifies the ISO 8601 timestamp of when the redemption was recorded in UTC.
..transactionIdentifier	String	Specifies the unique transaction identifier.
..transactionNumber	String	Specifies the bill or receipt number.
..promotionName	String	Specifies the name of the cart promotion.
..promotionMessageLabel	String	Specifies the display label for the cart promotion.
..transactionEntityIdentifier	String	Specifies the transaction entity identifier.
..cartEvaluationId	String	Specifies the ID of the cart evaluation session.
..redemptionTill	Number	Specifies the ID of the till where redemption occurred.
..discount	BigDecimal	Specifies the discount amount applied.
..redemptionCount	Number	Specifies the number of times redeemed in this transaction.
..amount	BigDecimal	Specifies the total amount of the line item or transaction.
..redemptionType	String	Specifies the type of redemption. Possible values: `CART`, `LINEITEM`,`PAYMENT_VOUCHER`.
..discountAppliedQuantity	BigDecimal	Specifies the quantity on which discount was applied .
..promotionAppliedQuantity	BigDecimal	Specifies the quantity on which cart promotion was applied.
..sku	String	Specifies the SKU of the item.
..productId	Number	Specifies the Product ID of the item.
errors	Array	Indicates a list of errors.