This API retrieves the cart promotion details for the organization. To retrieve promotion details for a specific promotion, use its cart promotion ID. You can provide multiple IDs as comma-separated values.

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/promotions/?promotionIds=68b5401db51b7777eca02900%2C68afffd77880ba5aa7cf2fb9%2C68661fe0ee52f074465e1062%2C%20686611bfee52f074465e1004' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic *******' \
--header 'Cookie: _cfuvid=9oSq7qMWziCR7BHQMrLE46pnF7WobiRVUQNbpmzDGiM-1756730125036-0.0.1.1-604800000; _cfuvid=xV2byQ98kShUeD74KBvXw39WiKQWRTPYck_nFdSIjfQ-1756809373698-0.0.1.1-604800000'

curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/promotions/?promotionIds=68b5401db51b7777eca02900' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic **********' \
--header 'Cookie: _cfuvid=9oSq7qMWziCR7BHQMrLE46pnF7WobiRVUQNbpmzDGiM-1756730125036-0.0.1.1-604800000; _cfuvid=aYNqXBj3GQL6eDlcHu3JHL5aL.p3VZ3zJ1j4XreCu1c-1756809494855-0.0.1.1-604800000'

curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/promotions/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic bmVlc3RvcmV0aWxsc3NuZWUyMzoyMDJjYjk2MTkwNzViOTY0YjA3MTUyZDIzNGI3MA==' \
--header 'Cookie: _cfuvid=9oSq7qMWziCR7BHQMrLE46pnF7WobiRVUQNbpmzDGiM-1756730125036-0.0.1.1-604800000; _cfuvid=cEokNpEZ7KaN9PsHveqwyFUhxxUO90bz2rE48rG8RDI-1756818458379-0.0.1.1-604800000'

Pre-requisites

Make sure you have the right authentication and appropriate access control configured:

Access group resource: Default
Authentication: Basic or OAuth authentication

Resource information


Pagination support	No
Rate limit	Demo and testing clusters: 1000 requests per minute per API key. Other organizations: Rate limit is brand-specific.
Batch support	Yes

Query parameter

Field	Type	Required	Description
promotionIDs	Array	Optional	Unique identifiers for the cart promotion, generated during the creation of the cart promotion. You can provide more than one cart promotion ID as comma-separated values.

Example response

{
    "data": [
        {
            "id": "68b5401db51b7777eca02900",
            "name": "SeptemberPromo",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "",
            "type": "CUSTOMER",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "GREATER_THAN_OR_EQUAL",
                    "value": "500.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "PERCENTAGE",
                    "value": "15.000000"
                }
            },
            "createdBy": 75139931,
            "createdOn": 1756708893457,
            "createdOnISO": "2025-09-01T06:41:33Z",
            "lastUpdatedBy": 75139931,
            "lastUpdatedOn": 1756709902063,
            "lastUpdatedOnISO": "2025-09-01T06:58:22Z",
            "startDate": 1756665000000,
            "startDateISO": "2025-08-31T18:30:00Z",
            "endDate": 1759256999999,
            "endDateISO": "2025-09-30T18:29:59Z",
            "campaignId": 264140,
            "promotionRestrictions": {},
            "earnLimitedToSpecificAudience": true,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": -1,
            "isStackable": false
        },
        {
            "id": "68afffd77880ba5aa7cf2fb9",
            "name": "AugustCartPromo",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "",
            "type": "CUSTOMER",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "GREATER_THAN_OR_EQUAL",
                    "value": "500.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "PERCENTAGE",
                    "value": "15.000000"
                }
            },
            "createdBy": 75139931,
            "createdOn": 1756364759642,
            "createdOnISO": "2025-08-28T07:05:59Z",
            "lastUpdatedBy": 75139931,
            "lastUpdatedOn": 1756364759642,
            "lastUpdatedOnISO": "2025-08-28T07:05:59Z",
            "startDate": 1756319400000,
            "startDateISO": "2025-08-27T18:30:00Z",
            "endDate": 1756664999999,
            "endDateISO": "2025-08-31T18:29:59Z",
            "campaignId": 264140,
            "promotionRestrictions": {},
            "earnLimitedToSpecificAudience": true,
            "customFieldValues": {
                "Age": "25"
            },
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 10,
            "isStackable": false
        },
        {
            "id": "68661fe0ee52f074465e1062",
            "name": "code promotion",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "GREATER_THAN_OR_EQUAL",
                    "value": "1000.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "100.000000"
                }
            },
            "createdBy": 75139931,
            "createdOn": 1751523296171,
            "createdOnISO": "2025-07-03T06:14:56Z",
            "lastUpdatedBy": 75139931,
            "lastUpdatedOn": 1751523296171,
            "lastUpdatedOnISO": "2025-07-03T06:14:56Z",
            "startDate": 1751481000000,
            "startDateISO": "2025-07-02T18:30:00Z",
            "endDate": 1753986599999,
            "endDateISO": "2025-07-31T18:29:59Z",
            "campaignId": 264140,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "limit": "5.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "686611bfee52f074465e1004",
            "name": "doc_promotions",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "",
            "type": "POS",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "ITEMCOUNT",
                    "operator": "EQUALS",
                    "value": "200.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "200.000000"
                }
            },
            "createdBy": 75160045,
            "createdOn": 1751519679886,
            "createdOnISO": "2025-07-03T05:14:39Z",
            "lastUpdatedBy": 75160045,
            "lastUpdatedOn": 1751519679886,
            "lastUpdatedOnISO": "2025-07-03T05:14:39Z",
            "startDate": 1751481000000,
            "startDateISO": "2025-07-02T18:30:00Z",
            "endDate": 1756664999999,
            "endDateISO": "2025-08-31T18:29:59Z",
            "campaignId": 264140,
            "promotionRestrictions": {},
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        }
    ]
}

{
    "data": [
        {
            "id": "68b5401db51b7777eca02900",
            "name": "SeptemberPromo",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "",
            "type": "CUSTOMER",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "GREATER_THAN_OR_EQUAL",
                    "value": "500.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "PERCENTAGE",
                    "value": "15.000000"
                }
            },
            "createdBy": 75139931,
            "createdOn": 1756708893457,
            "createdOnISO": "2025-09-01T06:41:33Z",
            "lastUpdatedBy": 75139931,
            "lastUpdatedOn": 1756709902063,
            "lastUpdatedOnISO": "2025-09-01T06:58:22Z",
            "startDate": 1756665000000,
            "startDateISO": "2025-08-31T18:30:00Z",
            "endDate": 1759256999999,
            "endDateISO": "2025-09-30T18:29:59Z",
            "campaignId": 264140,
            "promotionRestrictions": {},
            "earnLimitedToSpecificAudience": true,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": -1,
            "isStackable": false
        }
    ]
}

{
    "data": [
        {
            "id": "6938ff267438f54e9e1ae92a",
            "name": "FDS",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "Wfds",
            "type": "CUSTOMER",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "ITEMCOUNT",
                    "operator": "GREATER_THAN",
                    "value": "23.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "23.000000"
                }
            },
            "createdBy": 75184878,
            "createdOn": 1765343014180,
            "createdOnISO": "2025-12-10T05:03:34Z",
            "lastUpdatedBy": 75184878,
            "lastUpdatedOn": 1765343014180,
            "lastUpdatedOnISO": "2025-12-10T05:03:34Z",
            "startDate": 1765305000000,
            "startDateISO": "2025-12-09T18:30:00Z",
            "endDate": 1769797799999,
            "endDateISO": "2026-01-30T18:29:59Z",
            "campaignId": 296209,
            "promotionRestrictions": {},
            "earnLimitedToSpecificAudience": true,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f8562d26826df0676cbe",
            "name": "CODE promotion - jotest 7",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764227158259,
            "createdOnISO": "2025-11-27T07:05:58Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764227158259,
            "lastUpdatedOnISO": "2025-11-27T07:05:58Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1795761805000,
            "endDateISO": "2026-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "frequency": "WEEKS",
                        "minTimeBetweenRepeat": 86400000,
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f8022d26826df0676cba",
            "name": "CODE promotion - jotest6",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764227074173,
            "createdOnISO": "2025-11-27T07:04:34Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764227074173,
            "lastUpdatedOnISO": "2025-11-27T07:04:34Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1795761805000,
            "endDateISO": "2026-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "frequency": "DAYS",
                        "minTimeBetweenRepeat": 86400000,
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f7722d26826df0676cac",
            "name": "CODE promotion - jotest 5",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764226930025,
            "createdOnISO": "2025-11-27T07:02:10Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764226930025,
            "lastUpdatedOnISO": "2025-11-27T07:02:10Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1795761805000,
            "endDateISO": "2026-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "frequency": "DAYS",
                        "minTimeBetweenRepeat": 1,
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f7692d26826df0676cab",
            "name": "CODE promotion - jotest 4",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764226921149,
            "createdOnISO": "2025-11-27T07:02:01Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764226921149,
            "lastUpdatedOnISO": "2025-11-27T07:02:01Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1795761805000,
            "endDateISO": "2026-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "frequency": "DAYS",
                        "minTimeBetweenRepeat": 1,
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f6d72d26826df0676c9e",
            "name": "CODE promotion - jotest 3",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764226775869,
            "createdOnISO": "2025-11-27T06:59:35Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764226775869,
            "lastUpdatedOnISO": "2025-11-27T06:59:35Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1795761805000,
            "endDateISO": "2026-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "minTimeBetweenRepeat": 0,
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f6bd19bec5537d95c734",
            "name": "CODE promotion - jotest 2",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764226749074,
            "createdOnISO": "2025-11-27T06:59:09Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764226749074,
            "lastUpdatedOnISO": "2025-11-27T06:59:09Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1764225805500,
            "endDateISO": "2025-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "minTimeBetweenRepeat": 0,
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f65b19bec5537d95c733",
            "name": "CODE promotion - jotest",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764226651572,
            "createdOnISO": "2025-11-27T06:57:31Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764226651572,
            "lastUpdatedOnISO": "2025-11-27T06:57:31Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1764225805500,
            "endDateISO": "2025-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f6502d26826df0676c9d",
            "name": "CODE promotion",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "rgewrg",
            "type": "CODE",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "EQUALS",
                    "value": "2.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "1.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764226640224,
            "createdOnISO": "2025-11-27T06:57:20Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764226640224,
            "lastUpdatedOnISO": "2025-11-27T06:57:20Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1764225805500,
            "endDateISO": "2025-11-27T06:43:25Z",
            "campaignId": 296209,
            "promotionRestrictions": {
                "Code": [
                    {
                        "kpi": "REDEMPTION",
                        "limit": "1.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": false,
            "customFieldValues": {},
            "customerActivationRequired": false,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        },
        {
            "id": "6927f3822d26826df0676c92",
            "name": "customer_promotion testing5",
            "orgId": 100737,
            "priority": 0,
            "active": true,
            "messageLabel": "hbhjgjhhbh",
            "type": "CUSTOMER",
            "condition": {
                "type": "CART",
                "cartCondition": {
                    "kpi": "SUBTOTAL",
                    "operator": "GREATER_THAN",
                    "value": "4.000000"
                }
            },
            "action": {
                "type": "CART_BASED",
                "cartBasedAction": {
                    "type": "ABSOLUTE",
                    "value": "2.000000"
                }
            },
            "createdBy": 75197941,
            "createdOn": 1764225922905,
            "createdOnISO": "2025-11-27T06:45:22Z",
            "lastUpdatedBy": 75197941,
            "lastUpdatedOn": 1764225922905,
            "lastUpdatedOnISO": "2025-11-27T06:45:22Z",
            "startDate": 1764225805000,
            "startDateISO": "2025-11-27T06:43:25Z",
            "endDate": 1795761805000,
            "endDateISO": "2026-11-27T06:43:25Z",
            "campaignId": 1255614,
            "promotionRestrictions": {
                "Customer": [
                    {
                        "kpi": "TRANSACTION",
                        "frequency": "WEEKS",
                        "minTimeBetweenRepeat": 604800000,
                        "limit": "2.000000"
                    },
                    {
                        "kpi": "DISCOUNT",
                        "limit": "200.000000"
                    },
                    {
                        "kpi": "REDEMPTION",
                        "frequency": "DAYS",
                        "minTimeBetweenRepeat": 86400000,
                        "limit": "3.000000"
                    }
                ],
                "Cart": [
                    {
                        "kpi": "DISCOUNT",
                        "limit": "50.000000"
                    }
                ],
                "Promotion": [
                    {
                        "kpi": "REDEMPTION",
                        "limit": "5000.000000"
                    }
                ]
            },
            "earnLimitedToSpecificAudience": true,
            "customFieldValues": {},
            "customerActivationRequired": true,
            "mode": "DISCOUNT",
            "maxIssuancePerCustomer": 1,
            "isStackable": false
        }
    ]
}

Response parameters

Field	Type	Description
.data	Array	Array containing the cart promotion details.
..id	string	Unique identifier of the cart promotion.
..name	string	Name of the cart promotion.
..orgId	integer	Organization identifier where the cart promotion exists.
..priority	integer	Priority of the cart promotion. Lower value means higher priority.
..active	boolean	Shows if the cart promotion is active. `true` - enabled, `false` - disabled
..messageLabel	string	Custom label or message for the promotion.
..type	enum	Type of cart promotion. Possible values: CUSTOMER, POS, CODE, EARNING, REWARD.
..condition	Object	Object containing information on the conditions.
...type	enum	Type of condition applied. Possible value: CART, PRODUCT, COMBO_PRODUCT, TENDER
...cartCondition	Object	Object containing the details of the conditions.
....kpi	enum	KPI on which the condition is based. Possible values: SUBTOTAL, ITEMCOUNT
....operator	enum	Operator used for evaluation. Possible values: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, IN, NONE
....value	integer	Value used in the condition check.
..action	Object	Object containing details of the action.
...type	enum	Type of action triggered. Possible value: CART_BASED, FIXED_PRICE, PRODUCT_BASED, FREE_PRODUCT, TENDER, PER_UNIT
...cartBasedAction	Object	Object containing the
....type	enum	Type of benefit or discount applied. Possible values: PERCENTAGE, ABSOLUTE
....value	integer	Value of the discount in percentage.
..createdBy	integer	User ID of the creator.
..createdOn	string	Timestamp when the cart promotion is created
..createdOnISO	string	Specifies the date and time when the cart promotion was created in ISO 8601 format in UTC and is independent of the user’s local time zone.
..lastUpdatedBy	integer	User ID of the last updater.
..lastUpdatedOn	string	Timestamp when the cart promotion was last updated
..lastUpdatedOn	string	Specifies the date and time when the cart promotion was last updated in ISO 8601 format in UTC and is independent of the user’s local time zone.
..startDate	integer	Start date of the cart promotion.
..startDateISO	string	Specifies the start date of the cart promotion in UTC and is independent of the user’s local time zone.
..endDate	integer	End date of the cart promotion.
..endDateISO	string	Specifies the end date of the cart promotion in UTC and is independent of the user’s local time zone.
..campaignId	integer	Campaign identifier.
..promotionRestrictions	Object	Restrictions for applying the promotion.
..earnLimitedToSpecificAudience	Boolean	Indicates whether the cart promotion is limited to a specific audience.
..customFieldValues	Object	Custom fields or additional values.
..customerActivationRequired	boolean	Whether customers must activate the cart promotion before use.
..mode	enum	Mode of the promotion. Possible values: DISCOUNT, PAYMENT_VOUCHER
..maxIssuancePerCustomer	integer	Maximum times the promotion can be issued per customer. Maximum value: 50
..isStackable	boolean	Whether the promotion can be stacked with others.

Error codes

Code	Description
400	Invalid request. Check required parameters. Ensure all required parameters are provided and valid.
701	Error while calling the segmentation engine. Check segmentation engine service connectivity and logs.
702	Error while getting org entities. Confirm org entities exist and relevant services are operational.
703	Org timezone fetch failed. Verify org timezone configuration and service availability.
704	Invalid reward type passed. Provide a valid reward type as per API specification.
705	Exceeded maximum active promotions for an org. Deactivate some active promotions before creating a new one.
706	Promotion has expired. Use a valid, non-expired promotion for the operation.
707	The passed promotion type is not supported. Change the promotion type to one supported by the system.
708	Exceeded the max earn per customer limit. Adjust the earn amount or check the customer limits setup.
709	Promotion not in running state. Ensure the promotion is currently running before proceeding.
710	Error while saving earned promotion. Retry after checking backend/infrastructure logs.
711	Error while saving promotion or could not get product details. Check input data and ensure product service is available.
712	Error while creating/updating emf rules. Check rule configuration and retry or contact support.
713	Earned from type cannot be changed. Do not change `earnedFromType` on existing earned promotions.
714	Earn is not supported for this promotion type. Switch to a supported promotion type for earn operations.
715	Promotion was not issued to current customer. Ensure the promotion was issued to the specified customer.
716	Promotion name must be unique. Use an unused, unique promotion name.
500	Internal server error. Retry the request after a short delay, and contact support if the error persists.