The Create Cart API provides the ability to create a cart after items have been added to a basket. The API provides the ability to convert the basket into a corresponding order and order line item.
1POST /v3/cartsFirst, offers are configured without a cart, then this API is called to add the basket contents to the cart (order and order line items) before submitting. The API creates a new cart. The API will validate and price the cart after adding the items and returns a link to the full cart contents.
Beginning with the Summer 2019 release, the CacheAPI.CreateCartFromContextKey configuration setting can be used to determine the behavior of the Create Cart API. If set to true, the Create Cart API uses the cartContextKey passed in the input to create the cart. If set to false or not specified, the JSON result from the Basket API must be passed in the request body of the Create Cart API to create the cart. The API requires the user account, catalog code, and cartItems in the body of the request.
You can create multiple carts with a single Create Cart API call. See Create Cart from Basket for an example.
You can batch process multiple carts at one time. See Create Cart from Basket for an example.
You can submit an order when the cart is created. See Create Cart from Basket for an example.
You can pass additional order capture information when creating an order from a basket. See Create Cart from Basket for an example.
Pricing Interface (see pricing plans, such as ABP)
For known users, product validation rules are applied.
Run the Load API Metadata job (Vlocity CMT Administration > Cacheable API Jobs > Load API Metadata).
Run all of the jobs under the Populate API Cache window.
The CacheAPIFields custom setting must be set to true for versions prior to CME 103.1.14.
See Create Cart from Basket for additional recommendations.
For API parameter names and descriptions, see Digital Commerce REST API.
First, create a basket. To create a basket, first run the Basket API. Then, use the output of the Basket API as input for the Cart API. Be sure to add the catalogCode and accountId parameters.
The body should resemble the following (note that JSONResult has been truncated for clarity):
1{"JSONResult" : "{\"totalSize..."productCategories\":{\"totalSize\":0}}]}}]}","catalogCode" : "catalog_code","accountId" : "account_ID"}Now call the API:
1https://{salesforce_domain}/services/apexrest/vlocity_cmt/v3/cartsThe response includes the order number and order ID.
You can create multiple carts with a single API call by specifying the multipleCartContext parameter in the header.
By default, pricing and basket validation are turned off when using the Create Cart API for bulk processing.
Note
1URL:
2/services/apexrest/featurehvo/v3/carts?validate=false&price=false&validatebasket=false
3
4Header:
5{"multipleCartContext":[
6 {"accountId": "0016g000005GhgS",
7 "catalogCode": "Phones",
8 "cartContextKey": "03e2574d420baabe40c2210970afc837",
9 "orderItemFields": [
10 {
11 "bundleContextKey": "12b2d2fbbd91fab9b62c3689caf7e5a3",
12 "lineItemKey": "12b2d2fbbd91fab9b62c3689caf7e5a3",
13 "Description": "iphone 4"
14 }
15 ],"orderFields": {
16 "Description": "iphone 4"}
17 },
18 {
19 "accountId": "0016g00000LxUPf",
20 "catalogCode": "Phones",
21 "cartContextKey": "248c981213da8d58650d9c50ca578aff",
22 "orderItemFields": [
23 {
24 "bundleContextKey": "fcec25cc2013eca9f73db00b35020c29",
25 "lineItemKey": "fcec25cc2013eca9f73db00b35020c29",
26 "Description": "iphone 5"}],
27 "orderFields": {"Description": "iphone 5"}
28 },
29 {"accountId": "0016g00000LxUPL",
30 "catalogCode": "Phones",
31 "cartContextKey": "4ca6c995e66d71c163f509302566f7d6",
32 "orderItemFields":
33 [
34 {"bundleContextKey": "d61e242102fb4329e8a6acf273316159",
35 "lineItemKey": "d61e242102fb4329e8a6acf273316159",
36 "Description": "iphone 5s"}],
37 "orderFields": {
38 "Description": "iphone 5s"
39 }
40 }
41]
42}Output:
You can batch process multiple carts at one time.
1URL:
2/services/apexrest/featurehvo/v3/carts?validate=false&price=false&validatebasket=false
3
4Header
5{"multipleCartContext":[
6{"accountId": "0016g000005GhgS",
7"catalogCode": "Phones",
8"cartContextKey": "03e2574d420baabe40c2210970afc837",
9"orderItemFields": [
10{"bundleContextKey": "12b2d2fbbd91fab9b62c3689caf7e5a3",
11"lineItemKey": "12b2d2fbbd91fab9b62c3689caf7e5a3",
12"Description": "iphone 4"
13}
14],
15"orderFields": {
16"Description": "iphone 4"
17}
18},
19{"accountId": "0016g00000LxUPf",
20"catalogCode": "Phones",
21"cartContextKey": "248c981213da8d58650d9c50ca578aff",
22"orderItemFields": [
23{
24"bundleContextKey": "fcec25cc2013eca9f73db00b35020c29",
25"lineItemKey": "fcec25cc2013eca9f73db00b35020c29",
26"Description": "iphone 5"
27}
28],
29"orderFields": {
30"Description": "iphone 5"
31}
32},
33{
34"accountId": "0016g00000LxUPL",
35"catalogCode": "Phones",
36"cartContextKey": "4ca6c995e66d71c163f509302566f7d6",
37"orderItemFields": [
38{
39"bundleContextKey": "d61e242102fb4329e8a6acf273316159",
40"lineItemKey": "d61e242102fb4329e8a6acf273316159",
41"Description": "iphone 5s"
42}
43],
44"orderFields": {
45"Description": "iphone 5s"}
46},
47{"accountId": "0016g00000LxUPa",
48"catalogCode": "Phones",
49"cartContextKey": "2a060ccffb639df16448388fb944937c",
50"orderItemFields": [
51{
52"bundleContextKey": "3d2e9657bb10e96ef663669e5cd9f8e2",
53"lineItemKey": "3d2e9657bb10e96ef663669e5cd9f8e2",
54"Description": "iphone 6"}],
55"orderFields": {
56"Description": "iphone 6"
57}
58},
59{
60"accountId": "0016g00000LyRtK",
61"catalogCode": "Phones",
62"cartContextKey": "6eadc50ae768c46cb5a24847918cd84e",
63"orderItemFields": [
64{
65"bundleContextKey": "90801bc3d3ca1f1211fd7eff9fc576d9",
66"lineItemKey": "90801bc3d3ca1f1211fd7eff9fc576d9",
67"Description": "iphone 7"
68}
69],"orderFields": {
70"Description": "iphone 7"
71}
72}
73]
74}Output:
You can submit an order when the cart is created.
Creating assets using the CreateCart API can only be used with a single Create Cart API call.
Note
1URL:
2/services/apexrest/featurehvo/v3/carts?createAsset=true
3
4Header:
5{
6 "accountId": "0014R00002k5vPG",
7 "catalogCode": "Phones",
8 "cartContextKey": "1b42e612a401a072324c7ca026bc4e2f"
9}Output:
You can pass additional order capture information when creating an order from a basket. After a Basket has been created, and the user is ready to check out, you can pass additional information in the order header and order Line Items. For example, you might want to pass an updated billing address or an external Order Management system ID.
1URL:
2/services/apexrest/featurehvo/v3/carts
3
4Header:
5{
6 "accountId": "0016g000005GhgS",
7 "catalogCode": "Phones",
8 "cartContextKey": "03e2574d420baabe40c2210970afc837",
9 "orderItemFields": [
10 {
11 "bundleContextKey": "a561caa70bd9e2343a3066ed316bdec8",
12 "lineItemKey": "a561caa70bd9e2343a3066ed316bdec8",
13 "Description": "new iphone 4",
14 "featurehvo__ItemName__c": "iphone4"
15 }
16 ],
17"orderFields": {
18 "Description": "Apple Products",
19 "featurehvo__Email__c": "johndoe@gmail.com"
20 }
21}Output:
To prevent inadvertently updating a field that may invalidate ancillary operations, by default, the Create Cart API is restricted to updating only the following Order and OrderItem fields:
Order Item:
Line Description - Description
Item Name - vlocity_cmtItemNamec
Billing Account - vlocity_cmtBillingAccountIdc
Service Account - vlocity_cmtServiceAccountIdc
Service Point - vlocity_cmtServicePointIdc
Order:
Description - Description
Order Name - Name
Order Reference Number - OrderReferenceNumber
Order Type - Type
Delivery Installation Status - vlocity_cmtDelivery_Installation_Statusc
Email - vlocity_cmtEmailc
Lead Source - vlocity_cmtLeadSourcec
Billing Account - vlocity_cmtDefaultBillingAccountIdc
Service Account - vlocity_cmtDefaultServiceAccountIdc
Service Point - vlocity_cmtDefaultServicePointIdc
To update any fields other than the fields in the preceding list, you can create a fieldset on Orders for Order field updates and OrderProducts for OrderItem field updates. The fieldset name and label should match CartAllowedFieldSet for both Orders and OrderProducts.
By default, the Create Cart API is restricted to updating only the following Quote and QuoteItem fields:
Quote:
QuoteItem:
The following settings are recommended to increase performance when using the Create Cart API. These settings are appropriate when creating either single or multiple carts.
| Setting | Type | Value |
|---|---|---|
| CachedQueryMode | CPQ Configuration Setup | True |
| CacheEnabled | CPQ Configuration Setup | True |
| checkContextAuthenticity | query parameter | false |
| contextKey | query parameter | contextKey from getOffers |
| price | query parameter | false |
| returnOrderNumber | query parameter | false |
| UseAssetReferenceIdForParentAndRoot | CPQ Configuration Setup | True |
| validate | query parameter | false |
| validatebasket | query parameter | false |
See Also
j