This API can be used to fetch the Cart promotion details based on the code of the promotion

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/promotions/code?codes=DQCV73&mode=DISCOUNT' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data ''

Prerequisites

Authentication: Basic or OAuth authentication.
Default access group

Resource information


URI	/api_gateway/v1/promotions/code
HTTP Method	GET
Pagination	No
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
codes	String	Yes	Defines one or more promotion codes to retrieve. To query for multiple codes, repeat the codes query parameter for each code.
mode	String	Yes	Filters cart promotion based on the mode of promotion applied Supported values: `DISCOUNT`, `PAYMENT_VOUCHER`.
includeRedemptions	Boolean	Optional	If true, includes redemption details for the codes.

Example response

{
    "data": [
        {
            "id": "68fb18d331d91c625a8d9e52",
            "orgId": 100458,
            "promotionId": "68fb18a431d91c625a8d9e51",
            "promotionName": "eratg",
            "code": "DQCV73",
            "customerId": 566881933,
            "active": true,
            "createdOn": 1761286355257,
            "createdOnISO": "2025-10-24T06:12:35Z",
            "validTill": 1763787599999,
            "validTillISO": "2025-11-22T04:59:59Z",
            "mode": "DISCOUNT",
            "redeemableFrom": 1761286355257,
            "redeemableFromISO": "2025-10-24T06:12:35Z"
        }
    ]
}

Response parameters

Field	Type	Description
data	Array	Defines a list of promotion code objects.
..id	String	Specifies the unique identifier for the promotion code record.
..orgId	Number	Specifies the Organization ID.
..promotionId	String	Specifies the ID of the promotion meta this code belongs to.
..promotionName	String	Specifies the name of the promotion.
..code	String	Specifies the promotion code itself.
..customerId	Number	Specifies the customer ID this code is linked to.
..active	Boolean	Indicates whether the code is currently active.
..createdOn	Number	Indicates the timestamp f when the code was created. Time format: Epoch milliseconds
..createdOnISO	String	Specifies the ISO 8601 timestamp of when the code was created.
..validTill	Number	Indicates the timestamp of when the code expires. Time format : Epoch milliseconds
..validTillISO	String	Specifies the ISO 8601 timestamp of when the code expires.
..mode	String	Specifies the promotion mode.
..redeemableFrom	Number	Indicates the timestamp from when the code is redeemable. Time format: Epoch milliseconds
..redeemableFromISO	String	Specifies the ISO 8601 timestamp from when the code is redeemable.