Add Multiple Products to a Basket

You can add multiple products to a basket at one time using the Basket API. For example, a user might select multiple products and add them to the Basket using a single transaction.

Multi-add functionality works for both known and anonymous users. The basket is validated after the products are added.

Prerequisites

The Catalog should have CatalogCodec populated; spaces are not allowed in CatalogCodec.
Products should have ProductCode populated; spaces are not allowed in ProductCode.
The product catalog should be present with products attached to it as records under the CatalogProductRelationship__c object.
The product catalog should be attached to a default pricelist through the DefaultPriceListc field on the Catalogc object.
Price list entries should exist for all products attached to the catalog.
Create a custom setting called CacheAPIFields’ with the value set to True in the CPQ Configuration Setup.
Ensure you have run the following batch jobs to populate the cache:
- Context combinations
- Offer Details
- Pricing results

The API cache is generated incrementally with successive calls for this API, and is not pre-generated as is the case with some of the other APIs.
Multi-add promotion in a single basket API call is not supported in Classic DC APIs. Customers requiring this capability must migrate to Standard DC.

Note

URI

/services/apexrest/{namespace}/v3/catalogs/{catalogcode}/basket/{cartContextKey}

HTTP Method

POST

Parameters

Parameter	Description
CatalogCode	The code of the catalog whose product is being queried.
cartContextKey	A persistent cartContext hash key to maintain existing basket. Leave blank to create a new basked. For example: /v3/catalogs/{CATALOGCODE}/basket?urlParam=value

Required POST Body Parameters

basketAction

Choose an action type.

AddWithNoConfig If adding directly from offerCode; supplied to the offer parameter. AddAfterConfig If adding from configured offerDetails; supplied to the productConfig parameter.

isDebug

Set this parameter to true for debugging.

Optional POST Body Parameters

Parameter	Description
context	Provide context dimensions as part of context param; examples given at the end
productConfig	Provide configured offer details taken from response of configure API to add configured offer to cart. It will contain array in case of multi-add.
sessionKey	Persisting session Key that contains the combination of Order and BasketKey for fresh basket, don’t pass anything
offer	Offer code of the product being added has to be passed. It will contain array in case of multi-add.

Runtime Behavior

This API provides the ability for a user to add offers to a virtual basket maintained by the user interface. The basket is tracked using the cartContextKey in the URL. For an empty basket, there is no need to pass the cartContextKey.

1/v3/catalogs/{CATALOGCODE}/basket?urlParam=value

Depending upon the parameters passed along in the POST body the Orders are either picked from the Session else the pseudo Accounts and Orders are created. This changes the time for processing.

For an existing basket with COMPLETECACHEMISS, if the sessionKey is passed in the POST body params the existing Order is used to process else a new Account and Order are created.

The cartContextKey is returned as part of the response of a successful basket operation.
The sessionKey is returned as a part of a successful basket operation. The sessionKey is used to track the Order used for the current basket.
The API uses cartContext to track existing basket contents and appropriate context parameters to price products and run context rules.
The API uses the sessionKey to store the Order Id used to create the basket against the Basket ID. This provides performance improvement by avoiding creation of new Account and Order for every API call for a CACHE MISS scenario.
If pre-cached result is present, that will be returned in case it isn’t, this will be treated as a cache-miss and handled (also resulting in a corresponding cache entry)

Example

When the basket is empty, add an item to a basket without configuring.

1Method:
2POST
3
4URL:
5/services/apexrest/cacheableapis/v3/catalogs/Mobiles/basket
6
7Post body:
8{"offer":["iPhone11","iphone12"],"basketAction":"addWithNoConfig"}

Response body (truncated):

1{
2  "cartContextKey": "d48b4abf50f9f98b132202df490f1e62",
3  "createCartAction": {
4    "rest": {
5      "params": {
6        "cartContextKey": "d48b4abf50f9f98b132202df490f1e62"
7      },
8      "link": "/v3/carts",
9      "method": "createCartAction"
10    }
11  },
12  "sessionKey": "749b6aba422601cf548cd36401059956",
13  "result": {
14    "totals": {
15      "EffectiveOneTimeTotal__c": 200,
16      "EffectiveRecurringTotal__c": 100
17    },
18    "records": [
19      {
20        "actions": {
21          "deleteFromBasketAction": {
22            "rest": {
23              "params": {
24                "basketAction": "deleteFromBasket",
25                "lineItemKey": "dc4aaedd6a85c60ce7e857925c6bfcf1",
26                "bundleContextKey": "dc4aaedd6a85c60ce7e857925c6bfcf1"
27              },
28              "link": "/v3/catalogs/Mobiles/basket/d48b4abf50f9f98b132202df490f1e62?contextKey=99914b932bd37a50b983c5e7c90ae93b",
29              "method": "deleteFromBasketAction"
30            }
31          },
32          "updateBasketAction": {
33            "rest": {
34              "params": {
35                "basketAction": "updateBasket",
36                "lineItemKey": "dc4aaedd6a85c60ce7e857925c6bfcf1",
37                "bundleContextKey": "dc4aaedd6a85c60ce7e857925c6bfcf1"
38              },
39              "link": "/v3/catalogs/Mobiles/basket/d48b4abf50f9f98b132202df490f1e62?contextKey=99914b932bd37a50b983c5e7c90ae93b",
40              "method": "updateBasketAction"
41            }
42          }
43        },
44        "lineItemKey": "dc4aaedd6a85c60ce7e857925c6bfcf1",
45        "bundleContextKey": "dc4aaedd6a85c60ce7e857925c6bfcf1",
46        "productCategories": {
47          "messages": [],
48          "totalSize": 0
49        },
50        "pricingLogValue": {
51          "LastPricingTime": "2020-12-15T05:33:27.713Z",
52          "PriceAsOfDateTime": "2020-12-15T05:33:27.713Z",
53          "LogVersion": "3.0",
54          "PricingVariableCodeBaseValues": {
55            "REC_MNTH_STD_PRC": 50,
56            "OT_STD_PRC": 100

Example

When basket is empty, add an item to a basket after configuring.

1Method:
2POST
3
4URL:
5/services/apexrest/cacheableapis/v3/catalogs/Mobiles/basket
6
7POST Body (truncated)
8{
9  "productConfig": [
10    {
11      "offerDetails": {
12        "offer": {
13          "priceResult": [
14            {
15              "adjustments": [],
16              "overrides": [],
17              "chargeamount": 100,
18              "baseamount": 100,
19              "Amount__c": 100,
20              "IsVirtualPrice__c": false,
21              "IsBasePrice__c": true,
22              "effectiveuntildatespec": null,
23              "effectivefromdatespec": null,
24              "SubType__c": "Standard",
25              "Type__c": "Price",
26              "RecurringFrequency__c": null,
27              "ChargeType__c": "One-time",
28              "DisplayText__c": "100$ one time",
29              "UnitPrice": 100
30            },
31            {
32              "adjustments": [],
33              "overrides": [],
34              "chargeamount": 50,
35              "baseamount": 50,
36              "Amount__c": 50,
37              "IsVirtualPrice__c": false,
38              "IsBasePrice__c": true,
39              "effectiveuntildatespec": null,
40              "effectivefromdatespec": null,
41              "SubType__c": "Standard",
42              "Type__c": "Price",
43              "RecurringFrequency__c": "Monthly",
44              "ChargeType__c": "Recurring",
45              "DisplayText__c": "50$ recurring"
46            }
47          ],
48          "addtocart": {
49            "rest": {
50              "params": {
51                "context": "{}",
52                "basketAction": "AddWithNoConfig",
53                "offer": "iPhone11"
54              },
55              "link": "v3/catalogs/Mobiles/basket",
56              "method": "POST"
57            }
58          },

Example

When basket is empty, add one offer with configuration and another without configuration.

1Method:
2POST
3
4URL:
5/services/apexrest/cacheableapis/v3/catalogs/Mobiles/basket
6
7Post body (truncated):
8{
9  "offer": "iPhone12",
10  "productConfig": [
11    {
12      "offerDetails": {
13        "offer": {
14          "priceResult": [
15            {
16              "adjustments": [],
17              "overrides": [],
18              "chargeamount": 100,
19              "baseamount": 100,
20              "Amount__c": 100,
21              "IsVirtualPrice__c": false,
22              "IsBasePrice__c": true,
23              "effectiveuntildatespec": null,
24              "effectivefromdatespec": null,
25              "SubType__c": "Standard",
26              "Type__c": "Price",
27              "RecurringFrequency__c": null,
28              "ChargeType__c": "One-time",
29              "DisplayText__c": "100$ one time",
30              "UnitPrice": 100
31            },
32            {
33              "adjustments": [],
34              "overrides": [],
35              "chargeamount": 50,
36              "baseamount": 50,
37              "Amount__c": 50,
38              "IsVirtualPrice__c": false,
39              "IsBasePrice__c": true,
40              "effectiveuntildatespec": null,
41              "effectivefromdatespec": null,
42              "SubType__c": "Standard",
43              "Type__c": "Price",
44              "RecurringFrequency__c": "Monthly",
45              "ChargeType__c": "Recurring",
46              "DisplayText__c": "50$ recurring"
47            }
48          ],

Here is the response, truncated:

1{
2  "offer": "iPhone12",
3  "productConfig": [
4    {
5      "offerDetails": {
6        "offer": {
7          "priceResult": [
8            {
9              "adjustments": [],
10              "overrides": [],
11              "chargeamount": 100,
12              "baseamount": 100,
13              "Amount__c": 100,
14              "IsVirtualPrice__c": false,
15              "IsBasePrice__c": true,
16              "effectiveuntildatespec": null,
17              "effectivefromdatespec": null,
18              "SubType__c": "Standard",
19              "Type__c": "Price",
20              "RecurringFrequency__c": null,
21              "ChargeType__c": "One-time",
22              "DisplayText__c": "100$ one time",
23              "UnitPrice": 100
24            },
25            {
26              "adjustments": [],
27              "overrides": [],
28              "chargeamount": 50,
29              "baseamount": 50,
30              "Amount__c": 50,
31              "IsVirtualPrice__c": false,
32              "IsBasePrice__c": true,
33              "effectiveuntildatespec": null,
34              "effectivefromdatespec": null,
35              "SubType__c": "Standard",
36              "Type__c": "Price",
37              "RecurringFrequency__c": "Monthly",
38              "ChargeType__c": "Recurring",
39              "DisplayText__c": "50$ recurring"
40            }
41          ],
42          "addtocart": {
43            "rest": {
44              "params": {
45                "context": "{}",
46                "basketAction": "AddWithNoConfig",
47                "offer": "iPhone11"
48              },