Promotion Evaluation and Execution (POST)

Evaluate cart details and return the adjusted price of cart and line items after applying eligible promotions based on the selected promotion evaluation and execution method.

Resource

1/global-promotions-management/promotion-execution

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/global-promotions-management/promotion-execution

Available version

65.0

HTTP methods

POST

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`ruleLibraryApiName`	String	API Name of an active Rule Library with the usage type as Global Promotion Management. This parameter allows the API to check the eligibility of the cart against the promotions associated with the specified rule library. This parameter is required if there are multiple active rule libraries configured with the Usage Type as Global Promotion Management.	Optional	65.0

Request body for POST

JSON example

1{
2  "cart": {
3    "cartDetails": [
4      {
5        "cartHeaderId__std": "01ddf0000003kfMAAW",
6        "activityStartDate": "2023-06-14T12:45:19Z",
7        "contactId/contactEmail/contactLastName/loyaltyProgramMemberId/membershipNumber/accountId": "003xx000004WjzAAAS",
8        "transactionAmount": 110,
9        "currencyISOCode": "USD",
10        "engagementChannelId": "0eFxx0000000008EAA",
11        "sourceLocationId/sourceLocation": "0YQxx0000000001GAA",
12        "cartPromotionAdditionalInformation__std": [
13          {
14            "cartCouponCode__std": "CART5"
15          }
16        ],
17        "cartLineDetails": [
18          {
19            "cartLineProductId": "01txx0000006kfMAAQ",
20            "cartLineItemQuantity": 2,
21            "cartLineItemAmount": 100,
22            "cartLineItemId": "abcd1",
23            "cartLineNetUnitPrice__std": 50,
24            "cartLinePromotionAdditionalInformation__std": [
25              {
26                "cartLineCouponCode__std": "PIZZA5"
27              }
28            ]
29          },
30          {
31            "cartLineProductId": "01txx0000006kfNAAQ",
32            "cartLineItemQuantity": 2,
33            "cartLineItemAmount": 10,
34            "cartLineItemId": "abcd2",
35            "cartLineNetUnitPrice__std": 5
36          }
37        ]
38      }
39    ]
40  }
41}

Properties

Name	Type	Description	Required or Optional	Available Version
`cart`	Map<String, Object>	Details of a cart and its line items used to evaluate and execute promotions. The payload must include `cartHeaderId__std`, which uniquely identifies the cart and is required for promotion evaluation and execution. Specify the applicable `currencyISOCode` for the transaction. To evaluate or execute coupon-based promotions, include the `couponCode`, which must match an active coupon or promotion configured in the system. Along with the required parameters, provide cart-level details such as the total transaction amount, and cart line item details such as line item quantity and amount, `cartLineNetUnitPrice__std` (required for evaluation of line-level and cross-line promotions), and product ID.	Required	65.0

Name

Type

Description

Required or Optional

Available Version

cart

Map<String, Object>

Details of a cart and its line items used to evaluate and execute promotions.

The payload must include cartHeaderId__std, which uniquely identifies the cart and is required for promotion evaluation and execution.

Specify the applicable currencyISOCode for the transaction.

To evaluate or execute coupon-based promotions, include the couponCode, which must match an active coupon or promotion configured in the system.

Along with the required parameters, provide cart-level details such as the total transaction amount, and cart line item details such as line item quantity and amount, cartLineNetUnitPrice__std (required for evaluation of line-level and cross-line promotions), and product ID.

Required

65.0

Response body for POST

Cart

Loyalty Management Developer Guide

Promotion Evaluation and Execution (POST)