Cart Input Map | Loyalty Management Developer Guide

CartInputMapRepresentation

Here’s an example of the details of a customer’s cart whose eligible promotions are to be fetched:

Provide contactId to retrieve campaigns related to a Person Account.

Note

1{
2    "cart": {
3        "cartDetails": [
4            {
5                "activityStartDate": "2023-06-14T12:45:19Z",
6                "contactId/loyaltyProgramMemberId/accountId": "003xx000004WjzAAAS",
7                "transactionAmount": 499,
8                "currencyISOCode": "USD",
9                "engagementChannelId": "0eFxx0000000008EAA",
10                "sourceLocationId/sourceLocation": "0YQxx0000000001GAA",
11                "cartLineDetails": [
12                    {
13                        "cartLineProduct": "Burger",
14                        "cartLineProductCode": "testProductCode",
15                        "cartLineProductStockKeepingUnit": "testSKU",
16                        "cartLineProductCatalog" : "Food",
17                        "cartLineItemQuantity": 1,
18                        "cartLineItemAmount": 100,
19                        "cartLineProductCategory":"test"
20                    }
21                ]
22            }
23        ]
24    }
25}

Here’s an example of the details of a loyalty program member’s cart whose eligible loyalty program promotions are to be fetched:

1{
2   "cart":{
3      "cartDetails":[
4         {
5            "activityStartDate":"2023-06-14T12:45:19Z",
6            "contactId/loyaltyProgramMemberId/accountId": "003xx000004WjzAAAS"
7            "currencyISOCode":"INR",
8            "transactionAmount":499,
9            "membershipNumber":"Member-005",
10            "cartLineDetails":[
11               {
12                  "cartLineProductId":"01txx0000006iTsAAI",
13                  "cartLineProductCode": "AnyProductCode",
14                  "cartLineProductStockKeepingUnit": "AnySKU",
15                  "cartLineItemQuantity":2,
16                  "cartLineItemAmount":99,
17                  "cartLineProductCatalogId:"0ZSSB0000002d8X4AQ"
18               },
19               {
20                  "cartLineProduct":"Coke",
21                  "cartLineProductCode": "AnyProductCode",
22                  "cartLineProductStockKeepingUnit": "AnySKU",
23                  "cartLineItemQuantity":10,
24                  "cartLineItemAmount":400,
25                  "cartLineProductCatalog:"Beverages"
26               }
27            ]
28         }
29      ]
30   }
31}

Here’s an example to fetch eligible loyalty program promotions for accounts:

1{
2    "cart": {
3      "cartDetails": [
4        {
5          "activityStartDate": "2024-10-16T22:45:19Z",
6          "accountId": "001xx000003H3NnAAK",
7          "transactionAmount": 40,
8          "currencyISOCode": "USD",
9          "cartLineDetails": [
10            {
11              "cartLineProductCatalog": "Beverages",
12              "cartLineProductCategory": "Coffee Creations",
13              "cartLineProduct": "Caramel Latte",
14              "cartLineItemQuantity": 5
15            }
16          ]
17        }
18      ]
19    }
20  }

Name	Type	Description	Required or Optional	Available Version
`cart`	Map<String, Object>	Fields configured in the Cart and CartLine nodes of the `CartDetailGetEligiblePromotion` context service definition in your org. These fields represent the details of a cart and its line items whose eligible promotions are to be fetched. To get eligible promotions associated with a loyalty program member’s cart, the required parameters are: `membershipNumber` or `loyaltyProgramMemberId` `currencyISOCode` For other eligible promotions, the required parameters are: `contactId`, `contactLastName`, or `contactEmail` `currencyISOCode` Along with the required parameters, provide specific details of a cart, such as the total transaction amount, and the cart line item details, such as the line item quantity and amount, the product ID or name, the product catalog ID or name, the product code, and the product stock keeping unit.	Required	60.0

Name

Type

Description

Required or Optional

Available Version

cart

Map<String, Object>

Fields configured in the Cart and CartLine nodes of the CartDetailGetEligiblePromotion context service definition in your org. These fields represent the details of a cart and its line items whose eligible promotions are to be fetched.

To get eligible promotions associated with a loyalty program member’s cart, the required parameters are:

membershipNumber or loyaltyProgramMemberId
currencyISOCode

For other eligible promotions, the required parameters are:

contactId, contactLastName, or contactEmail
currencyISOCode

Along with the required parameters, provide specific details of a cart, such as the total transaction amount, and the cart line item details, such as the line item quantity and amount, the product ID or name, the product catalog ID or name, the product code, and the product stock keeping unit.

Required

60.0