Get Available Sites

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

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

Remote Method

getAvailableSites

REST Handler

APISitesCartsCpqV2

Apex Remote Service

CpqAppHandler

Apex Remote Input Map

{
  "methodName": "priceCart",
  "cartId": "801360000008eNU",
  "id":"01t36000000pfcKAAQ"
  "lookupField": "vlocity_cmt__BillingAccountId__c"
}

Package

Communication (vlocity_cmt)

API Parameters and Response Format

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

Example Request

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

Example Result

{
 "totalSize" => 2,
 "messages" => [],
 "actions" => {
  "newsite" => {
   "rest" => {
    "params" => {
     "fields" => "'Id'",
     "inputFields" =>
     "[{\"value\":null,\"previousValue\":null,\"originalValue\":null,\"messages\":[],\"label\":\"Account Name\",\"hidden\":null,\"fieldName\":\"name\",\"editable\":true,\"dataType\":\"STRING\",\"actions\":{}}]",
     "objectType" => "Account"
    },
    "method" => "POST",
    "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwG8QAI/sites"
   },
   "remote" => {
    "params" => {
     "fields" => "'Id'",
     "               inputFields" =>
     "[{\"value\":null,\"previousValue\":null,\"originalValue\":null,\"messages\":[],\"label\":\"Account Name\",\"hidden\":null,\"fieldName\":\"name\",\"editable\":true,\"dataType\":\"STRING\",\"actions\":{}}]",
     "objectType" => "Account",
     "cartId" => "8016A000000bwG8QAI",
     "methodName" => "newSite"
    }
   },
   "client" => {
    "params" => {}
   }
  }
 },
 "records" => [{
   "messages" => [],
   "displaySequence" => -1,
   "Id" => "0016A000006baXeQAI",
   "Name" => "SFA1"
  },
  {
   "messages" => [],
   "displaySequence" => -1,
   "Id" => "0016A000006bNfzQAE",
   "Name" => "SA"
  }
 ]
}