This API can be used fetch the configurations of the cart promotions through promotion ID.

Example request

curl --location 'https://{Host}/api_gateway/v1/promotions/config?promotionIds=68e7966845de881062349048&includeExpired=true&includeInactive=true' \
--header 'Authorization: Basic Z2VvcmdlvY2RlbNWI5ZjAxMzU5NGIwNDllZTk=' \
--header 'Cookie: _cfuvid=DWAI.W93CwD84bJoUrRqwVps-1761979737913-0.0.1.1-604800000' \
--data ''

Prerequisites

Authentication: Basic or OAuth authentication.
Default access group

Resource information


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
promotionIds	String	Yes	Defines the promotion ID using which you want to retrieve the cart promotion configuration details.
includeExpired	Boolean	Optional	If set as `true`, includes expired cart promotions in the response.
includeInactive	Boolean	Optional	If set as `true`, includes inactive cart promotions in the response.

Example response

{
    "data": [
        {
            "promotionId": "68e7966845de881062349048",
            "promotionName": "Goldpromo",
            "promotionType": "REWARD",
            "expiry": 1758738599999,
            "expiryISO": "2025-09-24T18:29:59Z",
            "description": "testing 1234",
            "reward": "Buy items of amount =  100.000000 Get 1000.000000 off on the bill",
            "isActive": true,
            "customFieldValues": {
                "qwer": ""
            },
            "promotionRestrictions": {}
        }
    ],
    "errors": []
}

Response parameters

Field	Type	Description
data	Array	Defines a list of cart promotion configuration objects.
..promotionId	String	Specifies the unique identifier for the cart promotion.
..promotionName	String	Specifies the name of the cart promotion.
..promotionType	String	Specifies the type of cart promotion.
..milestoneId	Number	Specifies the milestone ID.
..groupId	Number	Specifies the group ID.
..ruleId	Number	Specifies the rule ID.
..expiry	Number	Indicates the timestamp of when the cart promotion expires in UTC time zone.Time format: Epoch milliseconds
..expiryISO	String	Specifies the ISO 8601 timestamp of when the cart promotion expires in UTC.
..description	String	Specifies the description of the cart promotion.
..storeCriteria	Object	Defines store-based applicability rules.
..supplementaryCriteria	Object	Defines supplementary criteria.
..reward	String	Specifies the reward details.
..maxEarningPerCustomer	Number	Specifies the maximum number of times a customer can earn the cart promotion.
..isActive	Boolean	Indicates whether the cart promotion is currently active.
..customFieldValues	Object	Contains custom field key-value pairs associated with the cart promotion.
..promotionRestrictions	Object	Contains any restrictions applied to the cart promotion.
errors	Array	Specifies the errors messages.