Apply Adjustment

Apply an adjustment (such as a discount, markup, or override) to a price for a cart and line item, which are specified by the cartId and id parameters.

1POST /v2/cpq/carts/{cart_ID}/items/{ID}/pricing

The caller can add the new skipCartRefresh parameter to the applyAdjustments API call. If skipCartRefresh is set to True, the getCartsItems API will not be triggered. If it is omitted or set to False, getCartsItems will be triggered. The getCartsItems API runs pricing on the cart after adjustments are applied. Skipping this call significantly improves API performance.

To execute pricing after applyAdjustments, you can either call getCartLineItemPrices (available under the actions node in the response) or invoke getCartsItems separately.

Remote Method

1applyAdjustment

Example Request

1POST /services/apexrest/vlocity_cmt/v2/cpq/carts/{cartId}/items/{itemId}/pricing
2{
3  "adjustments": [
4    {
5      "DetailType": "ADJUSTMENT",
6      "Field": "vlocity_cmt__OneTimeCharge__c",
7      "PricingVariableCode": "OT_STD_PRC",
8      "AdjustmentType": "Adjustment",
9      "AdjustmentMethod": "Percent",
10      "AdjustmentValue": -50
11    }
12  ],
13  "skipCartRefresh": true
14}

Example Result

1{
2   "totalSize": 1,
3   "messages": [],
4   "records": [
5      {
6         "messages": [],
7         "actions": {
8            "addtocart": {
9               "rest": {
10                  "params": {
11                     "items": [
12                        {
13                        "quantity": 1,
14                        "parentId": "80246000000hhNzAAI",
15                        "itemId": "01u46000001Z8aCAAS"
16                     }
17                  ],
18                  "cartId": "80146000000h5jmAAA",
19                  "price": true,
20                  "validate": true,
21                  "includeAttachment": false,
22                  "pagesize": 20,
23                  "lastRecordId": null,
24                  "query": null
25               },
26               "method": "POST",
27               "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items"
28            },
29            "remote": {
30               "params": {
31                  "methodName": "postCartsItems",
32                  "items": [
33                     {
34                        "quantity": 1,
35                        "parentId": "80246000000hhNzAAI",
36                        "itemId": "01u46000001Z8aCAAS"
37                     }
38                  ],
39                  "cartId": "80146000000h5jmAAA",
40                  "price": true,
41                  "validate": true,
42                  "includeAttachment": false,
43                  "pagesize": 20,
44                  "lastRecordId": null,
45                  "query": null
46               }
47            },
48            "client": {
49               "params": {}
50            }
51         },
52         "updateitems": {
53            "rest": {
54               "params": {
55                  "items": [
56                     {
57                        "itemId": "80246000000hhNzAAI"
58                     }
59                  ],
60                  "filters": null,
61                  "fields": null,
62                  "cartId": "80146000000h5jmAAA",
63                  "price": true,
64                  "validate": true,
65                  "includeAttachment": false,
66                  "pagesize": 20,
67                  "lastRecordId": null,
68                  "query": null
69               },
70               "method": "PUT",
71               "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items"
72            },
73            "remote": {
74               "params": {
75                  "methodName": "putCartsItems",
76                  "items": [
77                     {
78                        "itemId": "80246000000hhNzAAI"
79                     }
80                  ],
81                  "filters": null,
82                  "fields": null,
83                  "cartId": "80146000000h5jmAAA",
84                  "price": true,
85                  "validate": true,
86                  "includeAttachment": false,
87                  "pagesize": 20,
88                  "lastRecordId": null,
89                  "query": null
90               }
91            },
92            "client": {
93               "params": {}
94            }
95         },
96         "deleteitem": {
97            "rest": {
98               "params": {},
99               "method": "DELETE",
100               "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI?pagesize=20&includeAttachment=false&validate=true&price=true&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI"
101            },
102            "remote": {
103               "params": {
104                  "methodName": "deleteCartsItems",
105                  "id": "80246000000hhNzAAI",
106                  "filters": null,
107                  "fields": null,
108                  "cartId": "80146000000h5jmAAA",
109                  "price": true,
110                  "validate": true,
111                  "includeAttachment": false,
112                  "pagesize": 20,
113                  "lastRecordId": null,
114                  "query": null
115               }
116            },
117            "client": {
118               "params": {}
119            }
120         },
121         "cloneitem": {
122            "rest": {
123               "params": {
124                  "items": [
125                     {
126                        "itemId": "80246000000hhNzAAI"
127                     }
128                  ],
129                  "id": "80246000000hhNzAAI",
130                  "cartId": "80146000000h5jmAAA"
131               },
132               "method": "POST",
133               "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/clone"
134            },
135            "remote": {
136               "params": {
137                  "methodName": "cloneItems",
138                     "items": [
139                        {
140                           "itemId": "80246000000hhNzAAI"
141                        }
142                     ],
143                     "id": "80246000000hhNzAAI",
144                     "cartId": "80146000000h5jmAAA"
145                  }
146               },
147               "client": {
148                  "params": {}
149                     }
150               },

An entire result can be thousands of lines long. This example has been truncated.

Note

API Troubleshooting

Use the table in this topic to diagnose problems that occur when executing the the API.

Error Message	Description
A virtual price cannot be adjusted.	This error message is displayed if you try to adjust a base price of a virtual product.
Cannot apply adjustment without base charge.	This error message is displayed:

1<li>If you try to adjust the base price of a product that hasn't been initialized. For example, If you haven't assigned a Recurring Charge Price List Entry to a product, and you try to apply an adjustment to the RecurringCharge, the API returns the error message.

1<li>If you try to adjust a calculated price, the API returns the error message.

Calculated prices are derived from other base prices. For example, the UnitPrice of a product is calculated based on the base price of the product and the quantity of the product.If you want to adjust base prices that haven’t been initialized, you can set the CheckVariableBasePrice CPQ Custom Setting to False. This setting allows you to make adjustments to the base prices, but it can lead to unexpected results.

Adjustments can be made without a PriceListEntryID.

Note