Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Cart Input

The details of a cart and its line items that's used to evaluate and execute promotions.

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

Loyalty Management Developer Guide

Cart Input