Get Available Sites

Get the available records for the billing account or service account lookup field.

1GET /v2/cpq/carts/{cart_ID}/sites?id={item_ID},lookupField={field_name},fields={field names to return}

Remote Method

1getAvailableSites

REST Handler

1APISitesCartsCpqV2

Apex Remote Service

1CpqAppHandler

Apex Remote Input Map

1{
2  "methodName": "priceCart",
3  "cartId": "801360000008eNU",
4  "id":"01t36000000pfcKAAQ"
5  "lookupField": "vlocity_cmt__BillingAccountId__c"
6}

Package

Communication (vlocity_cmt)

API Parameters and Response Format

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

Example Request

1GET
2/services/apexrest/vlocity_cmt/v2/cpq/carts/8014100000009fU/sites

Example Result

1{
2 "totalSize" => 2,
3 "messages" => [],
4 "actions" => {
5  "newsite" => {
6   "rest" => {
7    "params" => {
8     "fields" => "'Id'",
9     "inputFields" =>
10     "[{\"value\":null,\"previousValue\":null,\"originalValue\":null,\"messages\":[],\"label\":\"Account Name\",\"hidden\":null,\"fieldName\":\"name\",\"editable\":true,\"dataType\":\"STRING\",\"actions\":{}}]",
11     "objectType" => "Account"
12    },
13    "method" => "POST",
14    "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwG8QAI/sites"
15   },
16   "remote" => {
17    "params" => {
18     "fields" => "'Id'",
19     "               inputFields" =>
20     "[{\"value\":null,\"previousValue\":null,\"originalValue\":null,\"messages\":[],\"label\":\"Account Name\",\"hidden\":null,\"fieldName\":\"name\",\"editable\":true,\"dataType\":\"STRING\",\"actions\":{}}]",
21     "objectType" => "Account",
22     "cartId" => "8016A000000bwG8QAI",
23     "methodName" => "newSite"
24    }
25   },
26   "client" => {
27    "params" => {}
28   }
29  }
30 },
31 "records" => [{
32   "messages" => [],
33   "displaySequence" => -1,
34   "Id" => "0016A000006baXeQAI",
35   "Name" => "SFA1"
36  },
37  {
38   "messages" => [],
39   "displaySequence" => -1,
40   "Id" => "0016A000006bNfzQAE",
41   "Name" => "SA"
42  }
43 ]
44}