Get Price Waterfall for Price

Get the price waterfall for a price. The Get Price Details API retrieves the pricing details for a price field based on the cart context—opportunity, quote, order—specified by the cartId parameter and the line item ID.

Only the PricingElementServiceImplementation supports the Get Price Details API.

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

This API supports the guest user enhancements that Salesforce introduced with the Winter ‘21 release. To encrypt and decrypt data for guest users, use the UserSecurity class with this API. See Guest User Technical Details.

For additional information, see UserSecurity Class and CPQ and Digital Commerce Changes for Guest Users.

Remote Method

1getPriceDetail

Package

Communication (vlocity_cmt)

API Parameters and Response Format

For API parameter names and descriptions, see Cart-Based API Swagger Reference.

Resource Information

Response Format	JSON
Resource URL	`/services/apexrest/{namespace}/v2/cpq/carts/{cart_ID}/items/{ID}/pricing`

Example Request

1GET
2/services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000goGv/items/80246000000gZfO/pricing?fields=vlocity_cmt__OneTimeCharge__c

Example Response

1{
2   "totalSize": 1,
3   "messages": [],
4   "records": [
5      {
6         "messages": [],
7         "displaySequence": -1,
8         "id": "80246000000gZfOAAU",
9         "vlocity_cmt__OneTimeCharge__c": {
10            "pricedetail": [
11               {
12                  "actions": {},
13                  "DetailType": "PRICE",
14                  "Description": "$50 One Time Standard Price",
15                  "StartValue": 50,
16                  "EndValue": 50,
17                  "AdjustmentType": "None",
18                  "AdjustmentMethod": null,
19                  "AdjustmentValue": 0
20               },
21               {
22                  "actions": {},
23                  "DetailType": "ADJUSTMENT",
24                  "Description": "5% Discount on OT Std Price due to Bundle A...",
25                  "StartValue": 50,
26                  "EndValue": 47.5,
27                  "AdjustmentType": "Discount",
28                  "AdjustmentMethod": "Percent",
29                  "AdjustmentValue": -5
30                  },
31                  {
32                     "actions": {},
33                     "DetailType": "ADJUSTMENT",
34                     "Description": "10% Discount on OT Std Price due to Promotion 'Add Bundle A'",
35                     "StartValue": 47.5,
36                     "EndValue": 42.5,
37                     "AdjustmentType": "Discount",
38                     "AdjustmentMethod": "Percent",
39                     "AdjustmentValue": -10
40                  },
41                  {
42                     "actions": {},
43                     "DetailType": "ADJUSTMENT",
44                     "Description": "Additional 10% - Add Child 2 Promo",
45                     "StartValue": 42.5,
46                     "EndValue": 37.5,
47                     "AdjustmentType": "Discount",
48                     "AdjustmentMethod": "Percent",
49                     "AdjustmentValue": -10
50                  }
51               ]
52            }
53         }
54      ]
55}