Get Price Lists for Cart

Return the price lists available for a cart.

1GET /v2/cpq/carts/{cart_ID}/pricelists

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

1getPriceLists

REST Handler

1REST Endpoint: APIPriceListsCpqV2.cls
2Implementation: CpqGetPriceListsActionV2.cls

Apex Remote Service

1CpqAppHandler

Apex Remote Input Map

1{
2	methodName: getPriceLists
3	cartId: 80146000000 iwCx
4	pagesize: 2
5}

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}/pricelists

Example Request

1GET
2/services/apexrest/vlocity_cmt/v2/cpq/carts/8011I000000TUaK/pricelists?pagesize=10

Example Response

1{
2  "totalSize": 1,
3  "messages": [],
4  "records": [
5    {
6      "messages": [],
7      "actions": {
8        "setpricelist": {
9          "rest": {
10            "params": {
11              "inputFields": [
12                {
13                  "vlocity_cmt__PriceListId__c": "a2Y1I000000g50kUAA"
14                }
15              ]
16            },
17            "method": "POST",
18            "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/8011I000000XegcQAC"
19          },
20          "remote": {
21            "params": {
22              "inputFields": [
23                {
24                  "vlocity_cmt__PriceListId__c": "a2Y1I000000g50kUAA"
25                }
26              ],
27              "cartId": "8011I000000XegcQAC",
28              "methodName": "updateCarts"
29            }
30          },
31          "client": {
32            "params": {}
33          }
34        }
35      },
36      "displaySequence": -1,
37      "Id": "a2Y1I000000g50kUAA",
38      "Name": "Base PriceList"
39    }
40  ]
41}