--- schema_version: "1" id: e44299346825dd64dde13758349ea23090628337f081b00d775c8e7e5dd92fd1 title: Configure, Price, Quote (CPQ) REST APIs collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries/cme/references/generated-api-specs/cpq.md canonical_url: https://developer.salesforce.com/docs/industries/cme/references/cpq source_site: developer.salesforce.com content_type: documentation content_hash: e48ec59fceace66c7289052ce5d3a06b2464169fc274e9a92e1dff8921fd1a34 products: - Communications, Media, Energy and Utilities APIs (Managed Package) - Industries Developer Documentation --- Configure, Price, Quote (CPQ) REST APIs # Configure, Price, Quote (CPQ) REST APIs **Partial reference:** 1 operation(s) were omitted because their source references could not be resolved. Industries Configure, Price, Quote Web APIs (CPQ APIs) enable client application users to shop for and order products and services. The CPQ APIs provide a layer of abstraction between the client app developers and the CPQ developers who are configuring and customizing the underlying CPQ logic. * V2 of the CPQ APIs simplifies the APIs for mobile and external app development. The v2 APIs are the default APIs used by Industries applications. Base URL for the apis described is 'xx##.salesforce.com/services/apexrest/vlocity\_cmt/v2'. * To refer and access CPQ APIs swagger file (DEPRECATED), click [here](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/cpqapi.yaml.zip) to download. You can use an editor like editor.swagger.io to view the swagger based API doc. **Version:** Summer 2024 ## Servers * `https://{MyDomainLoginUrl}.salesforce.com/services/apexrest/vlocity_cmt/v2` Protocols: https. ## Operations ### POST Create Cart `POST /carts` Operation ID: `CreateCart`. Tags: Cart. Creates an opportunity, order, or quote based on the subaction specified in the request body. Subaction also defines method of creation. NOTE: The inputFields is not supported for AssetToOrder (subaction as assetToOrder). Subactions supported include. **createOrder** - Create an empty order from the specified inputs. **createQuote** - Create an empty quote from the specified inputs. **createOppty** - Create an empty opportunity from the specified inputs. **assetToOrder** - Create a change order initially populated from the specified assets. **assetToQuote** - Create a quote for changes initially populated from the specified assets. **assetChangeSite** - Create a change order to request moving the specified assets from one service location to another. \*\* Rest Handler - CpqCreateCartActionV2. Method Invoked - postCartItems.\*\* #### Request body (required) Different request bodies must be used for each of the different subactions. #### createOrder Request Example ```json { "subaction":"createOrder", "inputFields":[ { "effectivedate":"2017-12-25" }, { "status":"Draft" }, { "Name":"New customer order" }, { "AccountId":"0016A0000053kHN" }, { "Pricebook2Id":"01s6A000002Y7wz" }, { "pricebookName":"GeneralPricebook" }, { "pricelistName":"GeneralPricelist" }, { "vlocity_cmt__OriginatingChannel__c":"Retail" } ], "fields":"Id,Name,EffectiveDate,AccountId,Account.Name,vlocity_cmt__EffectiveRecurringTotal__c,vlocity_cmt__EffectiveOneTimeTotal__c,vlocity_cmt__EffectiveOrderTotal__c,TotalAmount,vlocity_cmt__OriginatingChannel__c,OrderNumber,OrderReferenceNumber,Pricebook2Id,pricebookName,pricelistName" } ``` #### createQuote Request Example ```json { "subaction":"createQuote", "inputFields":[ { "AccountId":"0016A0000053kHN" }, { "OpportunityId":"0066A000002aVklQAE" }, { "status":"Draft" }, { "Name":"New customer quote" }, { "Pricebook2Id":"01s6A000002Y7wz" }, { "pricebookName":"GeneralPricebook" }, { "pricelistName":"GeneralPricelist" }, { "vlocity_cmt__OriginatingChannel__c":"Retail" } ], "fields":"Id,QuoteNumber,Name,OpportunityId,Status,AccountId,Account.Name,vlocity_cmt__EffectiveRecurringTotal__c,vlocity_cmt__EffectiveOneTimeTotal__c,vlocity_cmt__EffectiveQuoteTotal__c,GrandTotal,vlocity_cmt__OriginatingChannel__c,pricebookName,pricelistName" } ``` #### createOppty Request Example ```json { "subaction":"createOppty", "inputFields":[ { "AccountId":"0016A0000053kHN" }, { "StageName":"Prospecting" }, { "Name":"New customer opportunity" }, { "Type":"New Customer" }, { "CloseDate":"2017-12-25" }, { "vlocity_cmt__NumberOfContractedMonths__c":24 }, { "Pricebook2Id":"01s6A000002Y7wz" }, { "pricebookName":"GeneralPricebook" }, { "pricelistName":"GeneralPricelist" }, { "vlocity_cmt__OriginatingChannel__c":"Dealer" } ], "fields":"Id,Name,AccountId,Account.Name,vlocity_cmt__EffectiveRecurringTotal__c,vlocity_cmt__EffectiveOneTimeTotal__c,vlocity_cmt__EffectiveOpportunityTotal__c,Amount,vlocity_cmt__OriginatingChannel__c,pricebookName,pricelistName" } ``` #### assetToOrder Request Example ```json { "subaction":"assetToOrder", "id":"01t36000000pfcKAAQ,02i6A000000YEXN", "accountId":"0016A0000072D3y", "requestDate":"2017-12-01" } ``` For assetToOrder, if future-dated order is not available, the requestDate should be greater than or equal to current date. If a future dated order(s) is/are available for that asset, the requestDate should be greater than or equal to current date and should be greater than or equal to the date on all the future dated orders of the asset. For assetToOrder, the field id can be a list of all assets or just the root asset. The child assets will be retrived from the root asset. #### assetToQuote Request Example ```json { "subaction":"assetToQuote", "listTypeAsset":"Service", "assetIdList":[ "02i5g000000tDi8" ], "accountId":"0015g000002vauG", "quoteId":"0065g000002fIKa", "opportunityId":null, "validate":false, "price":false } ``` For assetToQuote, the parametrs "quoteId","oportunityId","validate", and "price" are optional parameters. If the user passes quoteId, then opportunityId will be ignored. If the user passes opportunityId, but not quoteId, then the API will create a new Quote for that opportunity and move assets to the created quote. If the user passes neither quoteId not opportunityId, then the API will create a new opportunity record and a new quote for that opportunity. It will then move assets to the created quote. Default values of "validate" and "price" is true. User can pass false and turn off pricing and validation. #### assetChangeSite Request Example ````json { "OrderId":"8014x000000Y8ZzAAK" "moveOutDate":"2021-03-12", "assetIdList": ["02i4x000000YzIb"], "moveInAccountId":"0014x00000GSjX5", "moveOutAccountId":"0014x00000Ds89r", "subaction":"assetChangeSite" } ``` For assetChangeSite, the parameter "OrderId" is an optional parameter. If user doesn't pass the OrderId, then new Order will be created in the parent Account of moveIn Account. If no parent Account exists, then order will be created in the move Out account. The format of "moveOutDate" parameter should be YYYY-MM-DD. The API expects Ids of all assets in a bundle to be passed-in in "assetIdList" parameter. If only some of the Ids of an Asset bundle is passed, then only the passed-in asset Ids will be considered for "Move Order" creation. It will result in incorrect "move order" behaviour. ```` Media type: `application/json`. Schema: `CreateOrderBody`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Media type: `application/json`. Schema: `CreateCartResult`. * **400** Bad Request - Invalid subaction or Invalid Parameters ### GET Get Assets List `GET /cpq/assets` Operation ID: `GetAssetsList`. Tags: Assets. Returns a list of assets Rest Handler - V2GetAssetsService Method Invoked - execute #### Parameters * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `filters` (query, string) Filter field values. _Example_ ``` vlocity_cmt__AppliesTo__c:Account_Contract ``` * `offsetSize` (query, integer) Offset from which to start reading products, for pagination. _Example_ ``` 2 ``` * `sortBy` (query, string) Used to sort based on field(s). _Example_ ``` Name_DESC ``` * `searchBy` (query, string) Used for text searching. _Example_ ``` searchBy:hello ``` * `query` (query, string) Term used to search on result records. _Example_ ``` bundle ``` #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. #### Get Cart Items Response Example ```json { "totalSize": 1, "actions": { "nexttranslation": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/cmt_v102/v2/cpq/assets?pagesize=1&offsetSize=1¤tPage=2" }, "remote": { "params": {} }, "client": { "params": {} } } }, "records": [{ "displaySequence": -1, "Id": { "value": "02i4x0000001MNCAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "Asset ID", "hidden": true, "fieldName": "Id", "editable": false, "dataType": "ID", "alternateValues": null, "actions": {} }, "Quantity": { "value": 1.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Quantity", "hidden": true, "fieldName": "Quantity", "editable": false, "dataType": "DOUBLE", "alternateValues": null, "actions": {} }, "AccountId": { "value": "0014x00000AdQpyAAF", "previousValue": null, "originalValue": null, "messages": [], "label": "Account ID", "hidden": false, "fieldName": "AccountId", "editable": false, "dataType": "REFERENCE", "alternateValues": null, "actions": {} }, "vlocity_cmt__AssetReferenceId__c": { "value": "fe373aa5-d753-c7cf-aab6-b7aeaba324f0", "previousValue": null, "originalValue": null, "messages": [], "label": "Asset Reference Id", "hidden": true, "fieldName": "vlocity_cmt__AssetReferenceId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__OneTimeTotal__c": { "value": 246.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Total", "hidden": true, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": {} }, "vlocity_cmt__LineNumber__c": { "value": "0001", "previousValue": null, "originalValue": null, "messages": [], "label": "Line Number", "hidden": true, "fieldName": "vlocity_cmt__LineNumber__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__RootItemId__c": { "value": "02i4x0000001MNCAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "RootItemId", "hidden": true, "fieldName": "vlocity_cmt__RootItemId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__OneTimeCharge__c": { "value": 82.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Charge", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": {} }, "vlocity_cmt__SequenceNumber__c": { "value": 1, "previousValue": null, "originalValue": null, "messages": [], "label": "Sequence Number", "hidden": true, "fieldName": "vlocity_cmt__SequenceNumber__c", "editable": false, "dataType": "DOUBLE", "alternateValues": null, "actions": {} }, "Name": "P-10154", "childAssets": { "totalSize": 0, "records": [{ "displaySequence": -1, "Id": { "value": "02i4x0000001MNDAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "Asset ID", "hidden": true, "fieldName": "Id", "editable": false, "dataType": "ID", "alternateValues": null, "actions": {} }, "Quantity": { "value": 1.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Quantity", "hidden": true, "fieldName": "Quantity", "editable": false, "dataType": "DOUBLE", "alternateValues": null, "actions": {} }, "AccountId": { "value": "0014x00000AdQpyAAF", "previousValue": null, "originalValue": null, "messages": [], "label": "Account ID", "hidden": false, "fieldName": "AccountId", "editable": false, "dataType": "REFERENCE", "alternateValues": null, "actions": {} }, "vlocity_cmt__AssetReferenceId__c": { "value": "7be2d313-c6db-648c-d100-ec54d09975d9", "previousValue": null, "originalValue": null, "messages": [], "label": "Asset Reference Id", "hidden": true, "fieldName": "vlocity_cmt__AssetReferenceId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__OneTimeTotal__c": { "value": 164.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Total", "hidden": true, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": {} }, "vlocity_cmt__LineNumber__c": { "value": "0001.0001", "previousValue": null, "originalValue": null, "messages": [], "label": "Line Number", "hidden": true, "fieldName": "vlocity_cmt__LineNumber__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__RootItemId__c": { "value": "02i4x0000001MNCAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "RootItemId", "hidden": true, "fieldName": "vlocity_cmt__RootItemId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__ParentItemId__c": { "value": "02i4x0000001MNCAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "ParentItemId", "hidden": true, "fieldName": "vlocity_cmt__ParentItemId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__OneTimeCharge__c": { "value": 82.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Charge", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": {} }, "vlocity_cmt__SequenceNumber__c": { "value": 0, "previousValue": null, "originalValue": null, "messages": [], "label": "Sequence Number", "hidden": true, "fieldName": "vlocity_cmt__SequenceNumber__c", "editable": false, "dataType": "DOUBLE", "alternateValues": null, "actions": {} }, "Name": "V1-10154", "childAssets": { "totalSize": 0, "records": [{ "displaySequence": -1, "Id": { "value": "02i4x0000001MNEAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "Asset ID", "hidden": true, "fieldName": "Id", "editable": false, "dataType": "ID", "alternateValues": null, "actions": {} }, "Quantity": { "value": 1.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Quantity", "hidden": true, "fieldName": "Quantity", "editable": false, "dataType": "DOUBLE", "alternateValues": null, "actions": {} }, "AccountId": { "value": "0014x00000AdQpyAAF", "previousValue": null, "originalValue": null, "messages": [], "label": "Account ID", "hidden": false, "fieldName": "AccountId", "editable": false, "dataType": "REFERENCE", "alternateValues": null, "actions": {} }, "vlocity_cmt__AssetReferenceId__c": { "value": "b1dd9ab7-0e46-de7c-4d54-a2ebc3e14802", "previousValue": null, "originalValue": null, "messages": [], "label": "Asset Reference Id", "hidden": true, "fieldName": "vlocity_cmt__AssetReferenceId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__OneTimeTotal__c": { "value": 82.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Total", "hidden": true, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": {} }, "vlocity_cmt__LineNumber__c": { "value": "0001.0001.0001", "previousValue": null, "originalValue": null, "messages": [], "label": "Line Number", "hidden": true, "fieldName": "vlocity_cmt__LineNumber__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__RootItemId__c": { "value": "02i4x0000001MNCAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "RootItemId", "hidden": true, "fieldName": "vlocity_cmt__RootItemId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__ParentItemId__c": { "value": "02i4x0000001MNDAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "ParentItemId", "hidden": true, "fieldName": "vlocity_cmt__ParentItemId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": {} }, "vlocity_cmt__OneTimeCharge__c": { "value": 82.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Charge", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": {} }, "vlocity_cmt__SequenceNumber__c": { "value": 1, "previousValue": null, "originalValue": null, "messages": [], "label": "Sequence Number", "hidden": true, "fieldName": "vlocity_cmt__SequenceNumber__c", "editable": false, "dataType": "DOUBLE", "alternateValues": null, "actions": {} }, "Name": "C1-10154" } ] } } ] } } ] } ``` ### GET Get Cart Summary `GET /cpq/carts/{cartid}` Operation ID: `Get Cart Summary`. Tags: Cart. Returns a summary representation of the cart including: + Pricing information, such as total one-time charge and total recurring charge + Account information associated with this cart + If this cart includes a multisite order, available sites + Links to further actions, such as _check out_ Rest Handler - CpqCreateCartActionV2 Method Invoked - getCarts #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `validate` (query, boolean) Indicates whether validation rules are run for the current API request (true) or not (false). Default: `true`. _Example_ ``` true ``` * `price` (query, boolean) Indicates whether to run the pricing engine (true) or not (false). Default: `true`. _Example_ ``` true ``` * `headerFieldSet` (query, string) Name of a Salesforce Field Set defined for the given cart object (Opportunity, Quote, Order) which identifies the fields to return in the response. Omitting this parameter will return all fields from the cart object except the following fields: IsDeleted, CreatedDate, CreatedById, LastModifiedDate, LastModifiedById, SystemModstamp, LastActivityDate, CleanStatus. _Example_ ``` fieldSetFeature ``` * `translation` (query, boolean) to get translated labels, default is true (CMT 101) _Example_ ``` true ``` #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Media type: `application/json`. Schema: `CartResult`. ### PUT Update Cart Summary `PUT /cpq/carts/{cartid}` Operation ID: `UpdateCartSummary`. Tags: Cart. Update the cart summary. Rest Handler - APICartsCpqV2. Method Invoked - updateCarts #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` #### Request body (required) Request Body with input fields. #### Update Cart Request Example ```json { "inputFields":[ { "Pricebook2Id":"01s6A000002Y7wz" }, ], "fields":"Id,Name" } ``` Media type: `application/json`. Schema: `UpdateCartBody`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. ### GET Get Filterable Attributes `GET /cpq/carts/{cartid}/attributes` Operation ID: `GetFilterableAttributes`. Tags: Cart. Return the filterable attributes that are applicable for this cart, including Product attributes. The Product attribute values that the customer can choose to filter Products Rest Handler - APICartsAttributesCpqV2 Method Invoked - getCartsAttributes #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` #### Responses * **200** Return the filterable attributes that are applicable for this cart Media type: `application/json`. Schema: `CartAttributeDetail`. ### POST Runs validation and pricing for the items in the cart. `POST /cpq/carts/{cartid}/validate` Operation ID: `validate-POST`. Tags: Cart. Runs validation and pricing for the items in the cart. #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `price` (query, boolean) Indicates whether to run the pricing engine (true) or not (false). Default: `true`. _Example_ ``` true ``` * `validate` (query, boolean) Indicates whether validation rules are run for the current API request (true) or not (false). Default: `true`. _Example_ ``` true ``` #### Request body Request Body with cartId - required #### Validate Cart Request Example ```json { "cartId":"8011N00000157LkQAI", "methodName":"runCartValidation", "price":true, "validate":true } ``` Media type: `application/json`. Schema: `ValidateCartBody`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Rest Handler - validate Method Invoked - runCartValidation Media type: `application/json`. Schema: `ValidateCartResponse`. ### GET Get Cart Items `GET /cpq/carts/{cartid}/items` Operation ID: `Get Cart Items`. Tags: Cart. Get a representation of the items in a specified cart. Rest Handler - APIItemsCartsCpqV2 Method Invoked - getCartsItems #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `query` (query, string) Search text _Example_ ``` iphone+6s ``` * `id` (query, string) List of comma separated itemIds to return only the corresponding cart Items _Example_ ``` 01u41000001QPtsAAG ``` * `lastRecordId` (query, string) The last record ID from the previous search result, if available. _Example_ ``` 01uf4000001q1W3AAI ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `hierarchy` (query, integer) Specifies product hierarchy. _Example_ ``` 2 ``` * `includeAttachment` (query, boolean) Indicates whether product attachments are returned (true) or not (false). _Example_ ``` true ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `filter` (query, string) Filter field values. _Example_ ``` vlocity_cmt__ServiceAccountId__c:991360000008eNU_991360000008eNY ``` * `price` (query, boolean) Indicates whether to run the pricing engine (true) or not (false). Default: `true`. _Example_ ``` true ``` * `validate` (query, boolean) Indicates whether validation rules are run for the current API request (true) or not (false). Default: `true`. _Example_ ``` true ``` #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. #### Get Cart Items Response Example ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "addtocart": { "rest": { "params": { "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "itemId": "01u41000001QPtsAAG" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt__/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 10 "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "parentId": "80241000000HalcAAC", "quantity": 1, "itemId": "01u41000001QPtsAAG" }], "cartId": "80141000000Cg8HAAS", "methodName": "postCartsItems" } }, "client": { "params": {} } }, "updateitems": { "rest": { "params": { "fields": null, "price": true, "validate": true, "filters": null, "hierarchy": 0, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "query": null, "items": [{ "itemId": "80241000000HalcAAC" }] }, "method": "PUT", "link": "/services/apexrest/vlocity_cmt__/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "fields": null, "price": true, "validate": true, "filters": null, "hierarchy": 0, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "query": null, "items": [{ "itemId": "80241000000HalcAAC" }], "cartId": "80141000000Cg8HAAS", "methodName": "putCartsItems" } }, "client": { "params": {} } }, "displaySequence": -1, "Id": { "value": "80241000000HalcAAC", "messages": [], "label": "Order Product ID", "hidden": false, "fieldName": "Id", "editable": false, "dataType": "ID", "actions": {} }, "Pricebook2Id": "01s41000005dPYQAA2", "Product2Id": "01t41000000sYaSAAU", "UnitPrice": { "value": 1.00, "messages": [], "label": "Unit Price", "hidden": false, "fieldName": "UnitPrice", "editable": true, "dataType": "CURRENCY", "actions": {} }, "Name": "GC 2", "IsActive": true, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaSAAU" }, "Id": "01t41000000sYaSAAU", "Name": "GC 2", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "RecordTypeId": "012410000006OWUAA2", "vlocity_cmt__JSONAttribute__c": null }, "productId": "01t41000000sYaSAAU", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__ProductChildItem__c/a2541000000G0AGAA0" }, "Id": "a2541000000G0AGAA0", "Name": "Root PCI", "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t41000000sYaSAAU", "vlocity_cmt__ChildLineNumber__c": "1", "vlocity_cmt__SeqNumber__c": 1.00, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__IsRootProductChildItem__c": true, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaSAAU" }, "Id": "01t41000000sYaSAAU", "Name": "GC 2" } }, "productHierarchyPath":"01t41000000sYaSAAU", "name": "GC 2", "isVirtualItem": false, "itemType": "lineItem", "PricebookEntryId": { "value": "01u41000001QPtsAAG", "messages": [], "label": "Price Book Entry ID", "hidden": false, "fieldName": "PricebookEntryId", "editable": false, "dataType": "REFERENCE", "actions": {} }, "Quantity": { "value": 1.00, "messages": [], "label": "Quantity", "hidden": false, "fieldName": "Quantity", "editable": true, "dataType": "DOUBLE", "actions": {} }, "vlocity_cmt__OneTimeTotal__c": { "value": 1.00, "messages": [], "label": "One Time Total", "hidden": false, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "actions": {} }, "vlocity_cmt__SupplementalAction__c": { "value": "Amend" "messages": [], "label": "Supplemental Action", "hidden": false, "fieldName": "vlocity_cmt__SupplementalAction__c", "editable": true, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__RecurringTotal__c": { "value": 0.00, "messages": [], "label": "Recurring Total", "hidden": false, "fieldName": "vlocity_cmt__RecurringTotal__c", "editable": false, "dataType": "CURRENCY", "actions": {} }, "vlocity_cmt__OneTimeCharge__c": { "value": 1.00, "messages": [], "label": "One Time Charge", "hidden": false, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "actions": {} }, "vlocity_cmt__OneTimeCalculatedPrice__c": { "value": 1.00, "messages": [], "label": "One Time Calculated Price", "hidden": false, "fieldName": "vlocity_cmt__OneTimeCalculatedPrice__c", "editable": true, "dataType": "CURRENCY", "actions": {} }, "vlocity_cmt__OneTimeManualDiscount__c": { "value": 0.00, "messages": [], "label": "One Time Manual Discount", "hidden": false, "fieldName": "vlocity_cmt__OneTimeManualDiscount__c", "editable": true, "dataType": "PERCENT", "actions": {} }, "vlocity_cmt__RecurringCharge__c": { "value": 0.00, "messages": [], "label": "Recurring Charge", "hidden": false, "fieldName": "vlocity_cmt__RecurringCharge__c", "editable": false, "dataType": "CURRENCY", "actions": {} }, "vlocity_cmt__RecurringCalculatedPrice__c": { "value": 0.00, "messages": [], "label": "Recurring Calculated Price", "hidden": false, "fieldName": "vlocity_cmt__RecurringCalculatedPrice__c", "editable": true, "dataType": "CURRENCY", "actions": {} }, "vlocity_cmt__RecurringManualDiscount__c": { "value": 0.00, "messages": [], "label": "Recurring Manual Discount", "hidden": false, "fieldName": "vlocity_cmt__RecurringManualDiscount__c", "editable": true, "dataType": "PERCENT", "actions": {} }, "PricebookEntry": { "attributes": { "type": "PricebookEntry", "url": "/services/data/v38.0/sobjects/PricebookEntry/01u41000001QPtsAAG" }, "Id": "01u41000001QPtsAAG", "Product2Id": "01t41000000sYaSAAU", "Pricebook2Id": "01s41000005dPYQAA2", "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaSAAU" }, "Id": "01t41000000sYaSAAU", "Name": "GC 2", "vlocity_cmt__Type__c": "None", "vlocity_cmt__IsConfigurable__c": false } }, "vlocity_cmt__ServiceAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v38.0/sobjects/Account/00141000007uyWYAAY" }, "Id": "00141000007uyWYAAY", "Name": "telus test" }, "vlocity_cmt__BillingAccountId__r": { "attributes": { "type": "Account", "url": "/services/data/v38.0/sobjects/Account/00141000007uyWYAAY" }, "Id": "00141000007uyWYAAY", "Name": "telus test" }, "vlocity_cmt__InCartQuantityMap__c": { "value": null, "messages": [], "label": "InCartQuantityMap", "hidden": false, "fieldName": "vlocity_cmt__InCartQuantityMap__c", "editable": true, "dataType": "TEXTAREA", "actions": {} }, "vlocity_cmt__JSONAttribute__c": { "value": null, "messages": [], "label": "JSONAttribute", "hidden": false, "fieldName": "vlocity_cmt__JSONAttribute__c" "editable": true, "dataType": "TEXTAREA", "actions": {} } }] } ``` ``` ### PUT Update Item(s) in a Cart `PUT /cpq/carts/{cartid}/items` Operation ID: `Update Items in a Cart`. Tags: Cart. Update one or more items in a specified cart. Rest Handler - APIItemsCartsCpqV2 Method Invoked - putCartsItems #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` #### Request body Request Body with input fields #### Update Items in Cart Request Example ```json { "items": { "records": [ { "attributeCategories": { "totalSize": 0, "records": [ { "displaySequence": 7879, "Code__c": "CATEGORY_CODE-78231", "id": "a0K1I000002VwDEUA0", "productAttributes": { "totalSize": 0, "records": [ { "code": "CODE-70207", "dataType": "number", "inputType": "number", "required": false, "readonly": false, "disabled": false, "filterable": true, "attributeId": "a0L1I00000107vJUAQ", "label": "ATTRIBUTE-54063", "displaySequence": -1, "userValues": "9", "min": 0, "max": 0, "values": [ { "readonly": false, "disabled": false } ] } ] }, "Name": "ATTRIBUTE_CATEGORY-41131" } ] }, "PricebookEntry": { "Product2Id": "01t1I000001Q9PIQA0", "Pricebook2Id": "01s1I000006oNmAQAU", "Id": "01u1I000001sNdiQAE", "Product2": { "Name": "PRODUCT-68097", "Id": "01t1I000001Q9PIQA0", "vlocity_cmt__Type__c": "None", "vlocity_cmt__IsConfigurable__c": "false" } } } ] } } ``` Media type: `application/json`. Schema: `ValidateCartResponse`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. #### Update Cart Items response ```json { "totalSize": 1, "messages": [ { "code": "161", "severity": "INFO", "message": "Attributes modified successfully." } ], "records": [ { "messages": [ ], "displaySequence": -1, "PricebookEntry": { "Product2Id": "01t1I000001Q9PIQA0", "Pricebook2Id": "01s1I000006oNmAQAU", "Id": "01u1I000001sNdiQAE", "Product2": { "vlocity_cmt__IsConfigurable__c": "false", "vlocity_cmt__Type__c": "None", "Id": "01t1I000001Q9PIQA0", "Name": "PRODUCT-68097" } }, "attributeCategories": { "totalSize": 1, "messages": [ ], "records": [ { "messages": [ ], "displaySequence": 7879, "Code__c": "CATEGORY_CODE-78231", "Name": "ATTRIBUTE_CATEGORY-41131", "id": "a0K1I000002VwDEUA0", "productAttributes": { "totalSize": 3, "messages": [ ], "records": [ { "messages": [ ], "code": "CODE-77007", "dataType": "number", "inputType": "number", "required": true, "readonly": false, "disabled": false, "filterable": true, "attributeId": "a0L1I00000107vOUAQ", "label": "ATTRIBUTE-29707", "displaySequence": -1, "hasRules": true, "hidden": false, "values": [ { "readonly": false, "disabled": false } ], "userValues": null }, { "messages": [ ], "code": "CODE-70207", "dataType": "number", "inputType": "number", "required": false, "readonly": false, "disabled": false, "filterable": true, "attributeId": "a0L1I00000107vJUAQ", "label": "ATTRIBUTE-54063", "displaySequence": -1, "hasRules": true, "hidden": false, "values": [ { "readonly": false, "disabled": false, "value": 9 } ], "userValues": 9 }, { "messages": [ ], "code": "CODE-40063", "dataType": "number", "inputType": "number", "required": false, "readonly": false, "disabled": false, "filterable": true, "attributeId": "a0L1I00000107vTUAQ", "label": "ATTRIBUTE-77042", "displaySequence": -1, "hasRules": true, "hidden": false, "values": [ { "readonly": false, "disabled": false } ], "userValues": null } ] } } ] } } ] } ``` ### POST Add Item(s) to a Cart `POST /cpq/carts/{cartid}/items` Operation ID: `Add Items to a Cart`. Tags: Cart. Add one or more items to a specified cart. * Rest Handler * APIItemsCartsCpqV2 Method Invoked - postCartsItems * Spring 2020 enhancements (see examples below) * Additional support for Multi Add/delete of Root & child items * **noResponseNeeded** (set to **true**) will return just success or failure #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` * `price` (query, boolean) Indicates whether to run the pricing engine (true) or not (false). Default: `true`. _Example_ ``` true ``` * `validate` (query, boolean) Indicates whether validation rules are run for the current API request (true) or not (false). Default: `true`. _Example_ ``` true ``` * `hierarchy` (query, integer) Specifies product hierarchy. _Example_ ``` 2 ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `includeAttachment` (query, boolean) Indicates whether product attachments are returned (true) or not (false). _Example_ ``` true ``` * `expandAll` (query, boolean) Specifies level of hierarchy for assets. _Example_ ``` false ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` #### Request body Request Body with input fields #### Add Items to a Cart Request Example ```json { "items": [{ "itemId": "01uf4000000gmRTAAY", "parentId": "802f4000000PZ1VAAW", "parentRecord": { "records": [{ "messages": [ ], "displaySequence": -1, "Id": { "messages": [ ], "label": "Order Product ID", "hidden": false, "fieldName": "Id", "editable": false, "dataType": "ID", "value": "802f4000000PZ1VAAW" }, "UnitPrice": { "messages": [ ], "label": "Unit Price", "hidden": true, "fieldName": "UnitPrice", "editable": false, "dataType": "CURRENCY", "value": 358.95 }, "productId": "01tf4000000Kd0uAAC", "defaultQuantity": 1, "minQuantity": 0, "maxQuantity": 99999, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1, "productHierarchyPath": "01tf4000000Kd0uAAC", "itemType": "lineItem", "childProducts": { "records": [{ "Name": { "label": "Product Name", "value": "PRODUCT-77151" }, "UnitPrice": { "label": "List Price", "value": 0.0 }, "vlocity_cmt__RecurringPrice__c": { "label": "Recurring Price", "value": 0.0 }, "Product2Id": { "label": "Product ID", "value": "01tf4000000Kd0zAAC" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01sf4000003LYn3AAG" }, "Id": { "label": "Price Book Entry ID", "value": "01uf4000000gmRTAAY" }, "defaultQuantity": 0, "productId": "01tf4000000Kd0zAAC", "Product2": { "Name": "PRODUCT-77151", "RecordTypeId": "012f40000004zEOAAY", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__SubType__c": "None", "vlocity_cmt__Type__c": "None" }, "messages": [ ], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [{ "parentId": "802f4000000PZ1VAAW", "quantity": 0, "itemId": "01uf4000000gmRTAAY" }], "cartId": "801f4000000ChZjAAK" }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/801f4000000ChZjAAK/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [{ "parentId": "802f4000000PZ1VAAW", "quantity": 0, "itemId": "01uf4000000gmRTAAY" }], "cartId": "801f4000000ChZjAAK", "methodName": "postCartsItems" } }, "client": { "params": { "pagesize": 0, "hierarchy": 0 } } } } }] }, "vlocity_cmt__RecurringPrice__c": 527.96, "name": "PRODUCT-39982", "provisioningStatus": "New", "Product2Id": "01tf4000000Kd0uAAC", "PricebookEntryId": { "messages": [ ], "label": "Price Book Entry ID", "hidden": false, "fieldName": "PricebookEntryId", "editable": false, "dataType": "REFERENCE", "value": "01uf4000000gmRJAAY" }, "Quantity": { "messages": [ ], "label": "Quantity", "hidden": false, "fieldName": "Quantity", "editable": true, "dataType": "DOUBLE", "value": 1 }, "vlocity_cmt__OneTimeTotal__c": { "messages": [ ], "label": "One Time Total", "hidden": false, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "value": 358.95 }, "vlocity_cmt__RecurringTotal__c": { "messages": [ ], "label": "Recurring Total", "hidden": false, "fieldName": "vlocity_cmt__RecurringTotal__c", "editable": false, "dataType": "CURRENCY", "value": 527.96 }, "vlocity_cmt__OneTimeCharge__c": { "messages": [ ], "label": "One Time Charge", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "value": 358.95 }, "vlocity_cmt__RecurringCharge__c": { "messages": [ ], "label": "Recurring Charge", "hidden": true, "fieldName": "vlocity_cmt__RecurringCharge__c", "editable": false, "dataType": "CURRENCY", "value": 527.96 }, "vlocity_cmt__RecurringManualDiscount__c": { "messages": [ ], "label": "Recurring Manual Discount", "hidden": false, "fieldName": "vlocity_cmt__RecurringManualDiscount__c", "editable": true, "dataType": "PERCENT", "value": 0.0 }, "vlocity_cmt__OneTimeManualDiscount__c": { "messages": [ ], "label": "One Time Manual Discount", "hidden": false, "fieldName": "vlocity_cmt__OneTimeManualDiscount__c", "editable": true, "dataType": "PERCENT", "value": 0.0 }, "PricebookEntry": { "Product2Id": "01tf4000000Kd0uAAC", "Pricebook2Id": "01sf4000003LYn3AAG", "Id": "01uf4000000gmRJAAY", "Product2": { "Name": "PRODUCT-39982", "Id": "01tf4000000Kd0uAAC", "vlocity_cmt__Type__c": "None", "vlocity_cmt__IsConfigurable__c": "false" } }, "Product2": { "Name": "PRODUCT-39982", "RecordTypeId": "012f40000004zEOAAY", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__SubType__c": "None", "vlocity_cmt__Type__c": "None" }, "vlocity_cmt__ItemName__c": { "messages": [ ], "label": "Item Name", "hidden": false, "fieldName": "vlocity_cmt__ItemName__c", "editable": true, "dataType": "STRING" }, "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [{ "parentId": "802f4000000PZ1VAAW", "quantity": 1, "itemId": "01uf4000000gmRJAAY" }], "cartId": "801f4000000ChZjAAK" }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/801f4000000ChZjAAK/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [{ "parentId": "802f4000000PZ1VAAW", "quantity": 1, "itemId": "01uf4000000gmRJAAY" }], "cartId": "801f4000000ChZjAAK", "methodName": "postCartsItems" } }, "client": { "params": { "pagesize": 0, "hierarchy": 0 } } }, }, }], }, }] "hierarchy": 0, "pagesize": 0, "levelBasedApproach": false } ``` #### Multi ROOT Item Add Example Comma separated string should be passed as _itemId_ to support MultiAdd enhancement eg ```json { "items": [ { "itemId": "01uf400000HY8YuAAL,01uf400000HY8YkAAL" } ] } ``` #### Multi ROOT Item add example with NoResponse parameter * Comma separated string should be passed as **itemId** to support MultiAdd enhancement * **noResponseNeeded** set to **true** ```json { "noResponseNeeded": true, "items": [ { "itemId": "01uf400000HY8YuAAL,01uf400000HY8YkAAL" } ] } ``` #### Sample response with noResponseNeeded parameter ```json { "totalSize": 0, "messages": [ { "code": "150", "severity": "INFO", "message": "Successfully added." } ], "actions": { "itempricesupdated": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/h_cpq_daily/v2/cpq/carts/801f4000006lI3pAAE/price?price=false" }, "remote": { "params": { "price": false, "cartId": "801f4000006lI3pAAE", "methodName": "getCartLineItemPrices" } }, "client": { "params": {} } } } } ``` #### Multi CHILD Item Add Example Comma separated string should be passed as _itemId_ to support MultiAdd enhancement ```json { "items": [ { "parentId": "802f400000YzH8WAAV", "parentHierarchyPath": "01tf4000004ULpJAAW<01tf4000004ULpOAAW<01tf4000004ULpYAAW<01tf4000004ULpiAAG", "itemId": "01uf400000HY8YGAA1,01uf400000HY8YuAAL,01uf400000HY8YkAAL", "parentRecord": { "records": [ { "Id": "01tf4000004ULpiAAG", "productId": "01tf4000004ULpiAAG", "productHierarchyPath": "01tf4000004ULpJAAW<01tf4000004ULpOAAW<01tf4000004ULpYAAW<01tf4000004ULpiAAG", "itemType": "productGroup", "parentLineItemId": "802f400000YzH8WAAV" } ] } } ] } ``` #### Multi CHILD Item Add Example with NoResponse parameter * Comma separated string should be passed as **itemId** to support MultiAdd enhancement * **noResponseNeeded** set to **true** ```json { "noResponseNeeded": true, "items": [ { "parentId": "802f400000YzH8WAAV", "parentHierarchyPath": "01tf4000004ULpJAAW<01tf4000004ULpOAAW<01tf4000004ULpYAAW<01tf4000004ULpiAAG", "itemId": "01uf400000HY8YGAA1,01uf400000HY8YuAAL,01uf400000HY8YkAAL", "parentRecord": { "records": [ { "Id": "01tf4000004ULpiAAG", "productId": "01tf4000004ULpiAAG", "productHierarchyPath": "01tf4000004ULpJAAW<01tf4000004ULpOAAW<01tf4000004ULpYAAW<01tf4000004ULpiAAG", "itemType": "productGroup", "parentLineItemId": "802f400000YzH8WAAV" } ] } } ] } ``` Media type: `application/json`. Schema: `ValidateCartResponse`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. ### GET Get Applied or Available Promotions for a Cart `GET /cpq/carts/{cartid}/promotions` Operation ID: `Get Applied Promotions`. Tags: Cart. Promotions give a cart beneficial pricing or other benefits. A given cart for a given customer will only have certain promotions available to be applied to the cart. A cart can also already have one or more promotions applied. This GET operation will retrieve any promotions applied or available to the given cart. In different circumstances, qualification, penalty and evaluation rules are applied to promotions and the usage of the rules depends on the parameters set. **Sub Action** - By default (when _subaction=..._ is omitted from the request) this operation returns the list of promotions that are available to be applied to the given cart. Add the _subaction=getPromotionsAppliedToCart_ query parameter to instead request the list of promotions that are currently applied to the cart. * **subaction=getPromotionsAppliedToCart** - Return promotions currently applied to the cart. If an evaluation ruleset is applied then this method returns the qualified promotions based on the data provided in the ruelEvalautionInput parameter. * **subaction parameter omitted** - Return promotions that are available to be applied to the cart **include** - By default the qualifications for each promotion are not returned in the response because they take time to calculate. Add the _include=qualifications_ query parameter to request a list of required qualifications for each promotion and which are satisfied or not satisfied. If the _include=_ parameter is omitted, the _category_ fields and _qualifications_ arrays will not be returned in the response. Rest Handler - APIPromotionsCartsCpqV2 Method Invoked - getCartsPromotions #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `subaction` (query, string) An optional subaction that switches what data is returned from the request. Allowed values: `getPromotionsAppliedToCart`. * `include` (query, string) Optional components to include in the response. Currently only _qualifications_. Allowed values: `qualifications`. * `includePenalties` (query, boolean) whether to return the penalties for the promotions in the result or not _Example_ ``` true ``` * `ruleType` (query, string) Indicates which type of context rule to run. This should be used when we have includes param as qualifications or evaluation _Example_ ``` evaluation ``` * `ruleEvaluationInput` (query, string) The input to be used in the evaluation of context rules and it allows you to provide temporary values at run-time to determine if acustomer is eligible for a promotion without changing the actual values stored in Salesforce. Also, the format for the input should describe the sObject, the field and the temporary value that should be evaluated in JSON notation _Example_ ``` { "Order": { "OriginatingChannel__c": "Web" } } ``` * `filters` (query, string) Filter field values. _Example_ ``` vlocity_cmt__AppliesTo__c:Account_Contract ``` * `category` (query, string) Category to which the product belongs. _Example_ ``` Qualified, Disqualified ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `commitmentDateFilter` (query, string) Filters active applied promotions based on this date. _Example_ ``` 2017-04-05T07:00:00.000Z ``` * `appliedPromoStatusFilter` (query, string) Filter to specific the kind of applied promotions to be retrieved. _Example_ ``` Active ``` #### Responses * **200** | Response #### Get Applied Promotions for Cart Response ```json "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "deleteappliedpromoitems": { "rest": { "params": {}, "method": "DELETE", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/801f40000008UlxAAE/promotions?id=a2Lf4000000TvFmEAK" }, "remote": { "params": { "id": "a2Lf4000000TvFmEAK", "cartId": "801f40000008UlxAAE", "methodName": "deleteAppliedPromoItems" } }, "client": { "params": {} } }, "getpromodetails": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/801f40000008UlxAAE/promotions?id=a2Lf4000000TvFmEAK&subaction=getPromotionsAppliedToCart&includePenalties=true" }, "remote": { "params": { "includePenalties": true, "subaction": "getPromotionsAppliedToCart", "id": "a2Lf4000000TvFmEAK", "cartId": "801f40000008UlxAAE", "methodName": "getPromotionsAppliedToCart" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "value": "a2Lf4000000TvFmEAK", "previousValue": null, "originalValue": null, "messages": [], "label": "Record ID", "hidden": true, "fieldName": "Id", "editable": false, "dataType": "ID", "actions": {} }, "vlocity_cmt__BillingAccountId__c": { "value": "001f40000093uqMAAQ", "previousValue": null, "originalValue": null, "messages": [], "label": "Account", "hidden": true, "fieldName": "vlocity_cmt__BillingAccountId__c", "editable": true, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__Action__c": { "value": "Change", "previousValue": null, "originalValue": null, "messages": [], "label": "Action", "hidden": true, "fieldName": "vlocity_cmt__Action__c", "editable": true, "dataType": "PICKLIST", "actions": {} }, "vlocity_cmt__PromotionId__c": { "value": "a2ff4000000cHPMAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "Promotion", "hidden": true, "fieldName": "vlocity_cmt__PromotionId__c", "editable": true, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__Sequence__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Sequence", "hidden": true, "fieldName": "vlocity_cmt__Sequence__c", "editable": true, "dataType": "DOUBLE", "actions": {} }, "vlocity_cmt__FulfilmentStatus__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Fulfilment Status", "hidden": true, "fieldName": "vlocity_cmt__FulfilmentStatus__c", "editable": true, "dataType": "PICKLIST", "actions": {} }, "vlocity_cmt__ReasonForCancellation__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Reason for Cancellation", "hidden": true, "fieldName": "vlocity_cmt__ReasonForCancellation__c", "editable": true, "dataType": "STRING", "actions": {} }, "vlocity_cmt__RequestDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Request Date", "hidden": true, "fieldName": "vlocity_cmt__RequestDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__SubAction__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Sub Action", "hidden": true, "fieldName": "vlocity_cmt__SubAction__c", "editable": true, "dataType": "PICKLIST", "actions": {} }, "vlocity_cmt__CommitmentStartDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Commitment Start Date", "hidden": true, "fieldName": "vlocity_cmt__CommitmentStartDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__CommitmentEndDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Commitment End Date", "hidden": true, "fieldName": "vlocity_cmt__CommitmentEndDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__PricingStartDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Benefit Start Date", "hidden": true, "fieldName": "vlocity_cmt__PricingStartDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__PricingEndDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Benefit End Date", "hidden": true, "fieldName": "vlocity_cmt__PricingEndDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__AppliesTo__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Applies To", "hidden": true, "fieldName": "vlocity_cmt__AppliesTo__c", "editable": true, "dataType": "PICKLIST", "actions": {} }, "Name": "BundleJul19Promo", "Description": "BundleJul19Promo", "OrderRequestDate": "2017-11-13" }] } ``` ``` ### POST Add Promotion to a Cart `POST /cpq/carts/{cartid}/promotions` Operation ID: `Add Promotion to a Cart`. Tags: Cart. Add promotion to a specified cart. Rest Handler - APIPromotionsCartsCpqV2 Method Invoked - postCartsPromoItems #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` #### Request body Request Body with input fields #### Add Promotion to a Cart Request Example ```json { "items": [ { "itemId":"a30460000001vbgAAA" } ], "price": false, "validate": false, } ``` Media type: `application/json`. Schema: `PostPromoCartResponse`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. ### DELETE Delete of Promotion Items in Cart. `DELETE /cpq/carts/{cartid}/promotions` Operation ID: `Delete Promotion Items`. Tags: Cart. This API delete applied promotions items from cart Rest Handler - APIPromotionsCartsCpqV2 Method Invoked - deletePromotionItems #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `id` (query, string) Applied promotion item Id _Example_ ``` a2Lf40000008nL5EAI ``` #### Request body Request Body with input fields #### Delete Promotion Items in Cart Request Example ```json { "id": "a2Lf40000008nL5EAI", "cartId": "801f40000012NEIAA2", "methodName": "deleteAppliedPromoItems", "price": true, "validate": true } ``` Media type: `application/json`. Schema: `ValidateCartResponse`. #### Responses * **200** #### Response for Delete Promotion Items ```json { "totalSize": 0, "messages": [{ "severity": "INFO", "messageId": null, "message": "Successfully deleted.", "code": "152", "bundleId": null, "actions": {} }], "actions": { "itemdeleted": { "rest": { "params": {}, "method": null, "link": null }, "remote": { "params": {} }, "client": { "params": { "items": [{ "message": "add TestProd-12 bundle has been deleted from the cart.", "Id": "a2Lf40000008nL5EAI" }] } } } } } ``` ### GET Get Applied Promotions for a Customer Account `GET /accounts/{accountid}/promotions` Operation ID: `Get Applied Promotions`. Tags: Customer. Customers can have one or more active promotions applied which give them beneficial pricing or other benefits. This GET operation will retrieve any promotions applied to the given customer's assets, contracts or the account itself. **includes** - By default the qualifications for each applied promotion are not returned in the response because they take time to calculate. Add the _includes=qualifications_ query parameter to request a list of required qualifications and which are satisfied or not satisfied. If the _includes=_ parameter is omitted, the _category_ field and _qualifications_ array will not be returned in the response. **Filters** - By default all of the applied promotions are returned in the response. The _filters_ parameter allows returning a subset. Rest Handler - APIAppliedPromotionsAccountsV2 Method Invoked - getAppliedPromotionsByAccount #### Parameters * `accountid` (path, string, required) Customer Account ID (Salesforce ID). _Example_ ``` 001f4000007hynC ``` * `includes` (query, string) Optional components to include in the response. Currently only _qualifications_. Allowed values: `qualifications`. * `filters` (query, string) Filter field values. _Example_ ``` vlocity_cmt__AppliesTo__c:Account_Contract ``` * `category` (query, string) Category to which the product belongs. _Example_ ``` Qualified, Disqualified ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `commitmentDateFilter` (query, string) Filters active applied promotions based on this date. _Example_ ``` 2017-04-05T07:00:00.000Z ``` * `appliedPromoStatusFilter` (query, string) Filter to specific the kind of applied promotions to be retrieved. _Example_ ``` Active ``` * `ruleType` (query, string) Indicates which type of context rule to run. This should be used when we have includes param as qualifications or evaluation _Example_ ``` evaluation ``` * `ruleEvaluationInput` (query, string) The input to be used in the evaluation of context rules _Example_ ``` { "Order": { "OriginatingChannel__c": "Web" } } ``` #### Responses * **200** #### Response for Account Applied Promotions ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "displaySequence": -1, "Id": { "value": "a1if4000000Z1wTAAS", "previousValue": null, "originalValue": null, "messages": [], "label": "Record ID", "hidden": true, "fieldName": "Id", "editable": false, "dataType": "ID", "actions": {} }, "vlocity_cmt__BillingAccountId__c": { "value": "001f40000093uqMAAQ", "previousValue": null, "originalValue": null, "messages": [], "label": "Account", "hidden": true, "fieldName": "vlocity_cmt__BillingAccountId__c", "editable": false, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__PromotionId__c": { "value": "a2ff4000000cHPMAA2", "previousValue": null, "originalValue": null, "messages": [], "label": "Promotion", "hidden": true, "fieldName": "vlocity_cmt__PromotionId__c", "editable": true, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__Sequence__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Sequence", "hidden": true, "fieldName": "vlocity_cmt__Sequence__c", "editable": true, "dataType": "DOUBLE", "actions": {} }, "vlocity_cmt__CancellationDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Cancellation Date", "hidden": true, "fieldName": "vlocity_cmt__CancellationDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__CommitmentStartDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Commitment Start Date", "hidden": true, "fieldName": "vlocity_cmt__CommitmentStartDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__AppliesTo__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Applies To", "hidden": true, "fieldName": "vlocity_cmt__AppliesTo__c", "editable": true, "dataType": "PICKLIST", "actions": {} }, "vlocity_cmt__CancellationStatus__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Cancellation Status", "hidden": true, "fieldName": "vlocity_cmt__CancellationStatus__c", "editable": true, "dataType": "PICKLIST", "actions": {} }, "vlocity_cmt__ReasonForCancellation__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Reason for Cancellation", "hidden": true, "fieldName": "vlocity_cmt__ReasonForCancellation__c", "editable": true, "dataType": "STRING", "actions": {} }, "vlocity_cmt__CommitmentEndDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Commitment End Date", "hidden": true, "fieldName": "vlocity_cmt__CommitmentEndDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__PricingStartDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Benefit Start Date", "hidden": true, "fieldName": "vlocity_cmt__PricingStartDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "vlocity_cmt__PricingEndDate__c": { "value": null, "previousValue": null, "originalValue": null, "messages": [], "label": "Benefit End Date", "hidden": true, "fieldName": "vlocity_cmt__PricingEndDate__c", "editable": true, "dataType": "DATETIME", "actions": {} }, "Name": "BundleJul19Promo", "Description": "BundleJul19Promo" }] } ``` ### GET Get List of Products `GET /cpq/carts/{cartid}/products` Operation ID: `Get List of Products`. Tags: Cart. Get list of products available to be added to the cart based on the given criteria. Rest Handler - APIProductsCartsCpqV2 Method Invoked - getCartsProducts #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `maxProdListHierarchy` (query, integer) List of products returened in hierarchy. _Example_ ``` 5 ``` * `lastRecordId` (query, string) The last record ID from the previous search result, if available. _Example_ ``` 01uf4000001q1W3AAI ``` * `includeAttachment` (query, boolean) Indicates whether product attachments are returned (true) or not (false). _Example_ ``` true ``` * `filters` (query, string) Filter field values. _Example_ ``` vlocity_cmt__AppliesTo__c:Account_Contract ``` * `offsetSize` (query, integer) Offset from which to start reading products, for pagination. _Example_ ``` 2 ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `attributes` (query, string) Attribute filters. For example, for the attribute memory (attributecode=attr1) with selected values 16gb and 32gb and attribute color (attr2) with red selected, the format will be as shown in the example. _Example_ ``` attr1:attr116gb_32gb,attr2:red ``` * `includeAttributes` (query, boolean) Specifies whether to return a list of attributes and their values for the product. _Example_ ``` true ``` * `query` (query, string) Search text _Example_ ``` iphone+6s ``` #### Responses * **200** #### Response for Get List of Products ```json { "totalSize": 5, "messages": [], "actions": { "nextproducts": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlcoity_cmt/v2/cpq/carts/80141000000Cg8HAAS/products?hierarchy=0&lastRecordId=01u41000001QPtsAAG&pagesize=5&includeAttachment=false" }, "remote": { "params": { "includeAttachment": false, "pagesize": 5, "lastRecordId": "01u41000001QPtsAAG", "hierarchy": 0, "cartId": "80141000000Cg8HAAS", "methodName": "getCartsProducts" } }, "client": { "params": {} } } }, "records": [{ "messages": [], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPs0AAG" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPs0AAG" }], "cartId": "80141000000Cg8HAAS", "methodName": "postCartsItems" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u41000001QPs0AAG" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s41000005dPYQAA2" }, "Product2Id": { "label": "Product ID", "value": "01t41000000sYZQAA2" }, "UnitPrice": { "label": "List Price", "value": 1.00 }, "Name": { "label": "Product Name", "value": "Root 1" }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYZQAA2" }, "Id": "01t41000000sYZQAA2", "Name": "Root 1", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "RecordTypeId": "012410000006OWUAA2" }, "productId": "01t41000000sYZQAA2", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a2541000000G09wAAC", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__ProductChildItem__c/a2541000000G09wAAC" }, "Id": "a2541000000G09wAAC", "Name": "Root PCI", "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t41000000sYZQAA2", "vlocity_cmt__ChildLineNumber__c": "1", "vlocity_cmt__SeqNumber__c": 1.00, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__IsRootProductChildItem__c": true, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYZQAA2" }, "Id": "01t41000000sYZQAA2", "Name": "Root 1" } }, "productHierarchyPath": "01t41000000sYZQAA2", "name": "Root 1", "isVirtualItem": false, "attributeValues": {}, "itemType": "childProduct" }, { "messages": [], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPs5AAG" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPs5AAG" }], "cartId": "80141000000Cg8HAAS", "methodName": "postCartsItems" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u41000001QPs5AAG" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s41000005dPYQAA2" }, "Product2Id": { "label": "Product ID", "value": "01t41000000sYZVAA2" }, "UnitPrice": { "label": "List Price", "value": 2.00 }, "Name": { "label": "Product Name", "value": "Parent 1" }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYZVAA2" }, "Id": "01t41000000sYZVAA2", "Name": "Parent 1", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "RecordTypeId": "012410000006OWUAA2" }, "productId": "01t41000000sYZVAA2", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a2541000000G0A1AAK", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__ProductChildItem__c/a2541000000G0A1AAK" }, "Id": "a2541000000G0A1AAK", "Name": "Root PCI", "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t41000000sYZVAA2", "vlocity_cmt__ChildLineNumber__c": "1", "vlocity_cmt__SeqNumber__c": 1.00, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__IsRootProductChildItem__c": true, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYZVAA2" }, "Id": "01t41000000sYZVAA2", "Name": "Parent 1" } }, "productHierarchyPath": "01t41000000sYZVAA2", "name": "Parent 1", "isVirtualItem": false, "attributeValues": {}, "itemType": "childProduct" }, { "messages": [], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPtmAAG" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPtmAAG" }], "cartId": "80141000000Cg8HAAS", "methodName": "postCartsItems" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u41000001QPtmAAG" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s41000005dPYQAA2" }, "Product2Id": { "label": "Product ID", "value": "01t41000000sYaIAAU" }, "UnitPrice": { "label": "List Price", "value": 1.00 }, "Name": { "label": "Product Name", "value": "Child 1" }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaIAAU" }, "Id": "01t41000000sYaIAAU", "Name": "Child 1", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "RecordTypeId": "012410000006OWUAA2" }, "productId": "01t41000000sYaIAAU", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a2541000000G0A6AAK", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__ProductChildItem__c/a2541000000G0A6AAK" }, "Id": "a2541000000G0A6AAK", "Name": "Root PCI", "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t41000000sYaIAAU", "vlocity_cmt__ChildLineNumber__c": "1", "vlocity_cmt__SeqNumber__c": 1.00, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__IsRootProductChildItem__c": true, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaIAAU" }, "Id": "01t41000000sYaIAAU", "Name": "Child 1" } }, "productHierarchyPath": "01t41000000sYaIAAU", "name": "Child 1", "isVirtualItem": false, "attributeValues": {}, "itemType": "childProduct" }, { "messages": [], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPtrAAG" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPtrAAG" }], "cartId": "80141000000Cg8HAAS", "methodName": "postCartsItems" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u41000001QPtrAAG" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s41000005dPYQAA2" }, "Product2Id": { "label": "Product ID", "value": "01t41000000sYaNAAU" }, "UnitPrice": { "label": "List Price", "value": 1.00 }, "Name": { "label": "Product Name", "value": "GC 1" }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaNAAU" }, "Id": "01t41000000sYaNAAU", "Name": "GC 1", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "RecordTypeId": "012410000006OWUAA2" }, "productId": "01t41000000sYaNAAU", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a2541000000G0ABAA0", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__ProductChildItem__c/a2541000000G0ABAA0" }, "Id": "a2541000000G0ABAA0", "Name": "Root PCI", "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t41000000sYaNAAU", "vlocity_cmt__ChildLineNumber__c": "1", "vlocity_cmt__SeqNumber__c": 1.00, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__IsRootProductChildItem__c": true, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaNAAU" }, "Id": "01t41000000sYaNAAU", "Name": "GC 1" } }, "productHierarchyPath": "01t41000000sYaNAAU", "name": "GC 1", "isVirtualItem": false, "attributeValues": {}, "itemType": "childProduct" }, { "messages": [], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPtsAAG" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPtsAAG" }], "cartId": "80141000000Cg8HAAS", "methodName": "postCartsItems" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u41000001QPtsAAG" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s41000005dPYQAA2" }, "Product2Id": { "label": "Product ID", "value": "01t41000000sYaSAAU" }, "UnitPrice": { "label": "List Price", "value": 1.00 }, "Name": { "label": "Product Name", "value": "GC 2" }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaSAAU" }, "Id": "01t41000000sYaSAAU", "Name": "GC 2", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "RecordTypeId": "012410000006OWUAA2" }, "productId": "01t41000000sYaSAAU", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a2541000000G0AGAA0", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__ProductChildItem__c/a2541000000G0AGAA0" }, "Id": "a2541000000G0AGAA0", "Name": "Root PCI", "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t41000000sYaSAAU", "vlocity_cmt__ChildLineNumber__c": "1", "vlocity_cmt__SeqNumber__c": 1.00, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__IsRootProductChildItem__c": true, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYaSAAU" }, "Id": "01t41000000sYaSAAU", "Name": "GC 2" } }, "productHierarchyPath": "01t41000000sYaSAAU", "name": "GC 2", "isVirtualItem": false, "attributeValues": {}, "itemType": "childProduct" }] } ``` ### GET Get details of a product. `GET /cpq/carts/{cartid}/products/{pricebookEntryId}` Operation ID: `Get details of a product`. Tags: Cart. Get details of given pricebookentry id product available to be added to the cart based on the given criteria. Rest Handler - APIProductsCartsCpqV2 Method Invoked - getCartsProductsById #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `pricebookEntryId` (path, string, required) Price book entry ID (Salesforce ID). _Example_ ``` 01u46000002U5LKAA0 ``` * `maxProdListHierarchy` (query, integer) List of products returened in hierarchy. _Example_ ``` 5 ``` * `includeAttachment` (query, boolean) Indicates whether product attachments are returned (true) or not (false). _Example_ ``` true ``` * `filters` (query, string) Filter field values. _Example_ ``` vlocity_cmt__AppliesTo__c:Account_Contract ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `includeAttributes` (query, boolean) Specifies whether to return a list of attributes and their values for the product. _Example_ ``` true ``` #### Responses * **200** #### Response for get details of a Product ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPs0AAG" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80141000000Cg8HAAS/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 5, "lastRecordId": null, "hierarchy": 0, "query": null, "items": [{ "quantity": 1, "itemId": "01u41000001QPs0AAG" }], "cartId": "80141000000Cg8HAAS", "methodName": "postCartsItems" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u41000001QPs0AAG" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s41000005dPYQAA2" }, "Product2Id": { "label": "Product ID", "value": "01t41000000sYZQAA2" }, "UnitPrice": { "label": "List Price", "value": 1.00 }, "Name": { "label": "Product Name", "value": "Root 1" }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYZQAA2" }, "Id": "01t41000000sYZQAA2", "Name": "Root 1", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "RecordTypeId": "012410000006OWUAA2" }, "productId": "01t41000000sYZQAA2", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a2541000000G09wAAC", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__ProductChildItem__c/a2541000000G09wAAC" }, "Id": "a2541000000G09wAAC", "Name": "Root PCI", "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t41000000sYZQAA2", "vlocity_cmt__ChildLineNumber__c": "1", "vlocity_cmt__SeqNumber__c": 1.00, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__IsRootProductChildItem__c": true, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v38.0/sobjects/Product2/01t41000000sYZQAA2" }, "Id": "01t41000000sYZQAA2", "Name": "Root 1" } }, "productHierarchyPath": "01t41000000sYZQAA2", "name": "Root 1", "isVirtualItem": false, "attributeValues": {}, "itemType": "childProduct" } ``` ### GET Get Available Sites `GET /cpq/carts/{cartid}/sites` Operation ID: `Get Available Sites`. Tags: Cart. Gets the available records for the billing account or service account look up field. Remote Handler-APISitesCartsCpqV2 Method Invoked - getAvailableSites #### Parameters * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `lookupField` (query, string, required) Field on the line item to look up _Example_ ``` vlocity_cmt__BillingAccountId__c ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` #### Responses * **200** #### Response for Get Available Sites ```json { "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" } ] } ``` ### POST Create a New Account for the Current Cart. `POST /cpq/carts/{cartid}/sites` Operation ID: `Create a New Account`. Tags: Cart. Create a new account. Remote Handler- APISitesCartsCpqV2 #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` * `objectType` (query, string, required) Object type to create _Example_ ``` Account ``` * `inputFields` (query, array of string) List of fields to fill #### Request body (required) Request Body with cartId - required #### Create a new account for current site ```json { "objectType": "Account", "inputFields": [ { "value": "Test1234", "fieldName": "name" } ], "fields": "Name,vlocity_cmt__Active__c", } ``` Media type: `application/json`. Schema: `ValidateCartBody`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Media type: `application/json`. Schema: `SiteResult`. * **400** Bad Request - Invalid Parameter ### GET Get Asset List `GET /accounts/{accountId}/assets` Operation ID: `Get a list of assets`. Tags: Customer. Get a list of assets given acount Id and account type to be included.RestHandler- CpqAssetsContractsActionV2 Mehtod Invoked -getAssetsByAccount #### Parameters * `accountId` (path, string, required) Id of Account for Asset List _Example_ ``` 001f4000007hynC ``` * `includes` (query, string) type of account which the asset belongs to - billedAssets|serviceAssets|noContractAssets|customizedFilterAssets _Example_ ``` billedAssets ``` * `hierarchy` (query, integer (int32)) level of hierarchy for assets * `pagesize` (query, integer) Number of records to be returned _Example_ ``` 10 ``` * `effectiveAssetsDateFilter` (query, string) An optional date used to filter the effectivity dates for filtering the disconnected assets. If this parameter is not passed in, the API will use the current date and time. _Example_ ``` 2017-04-05T07:00:00.000Z ``` * `includeCatalogCodes` (query, boolean) Indicates whether to include assetToBasket action in the response. The catalog codes associated with the asset are returned in the assetToBasket action node, using which assetToBasket action can be performed. Default: `false`. _Example_ ``` false ``` #### Responses * **200** #### Response for Get Asset List for Account ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "assetchangesite": { "rest": { "params": {}, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/carts?subaction=assetChangeSite" }, "remote": { "params": { "assetList": ["02i1I00000058doQAA"], "moveDate": null, "toServiceLocation": null, "fromServiceLocation": null } }, "client": { "params": {} } }, "assettoquote": { "rest": { "params": {}, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/carts?subaction=assetToQuote" }, "remote": { "params": { "assetList": ["02i1I00000058doQAA"], "requestDate": null } }, "client": { "params": {} } }, "assettoorder": { "rest": { "params": {}, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/carts?subaction=assetToOrder" }, "remote": { "params": { "assetList": ["02i1I00000058doQAA"], "requestDate": null } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "value": "02i1I00000058doQAA", "previousValue": null, "originalValue": null, "messages": [], "label": "Asset ID", "hidden": true, "fieldName": "Id", "editable": false, "dataType": "ID", "actions": {} }, "Quantity": { "value": 1.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Quantity", "hidden": true, "fieldName": "Quantity", "editable": false, "dataType": "DOUBLE", "actions": {} }, "vlocity_cmt__ProvisioningStatus__c": { "value": "Active", "previousValue": null, "originalValue": null, "messages": [], "label": "Provisioning Status", "hidden": true, "fieldName": "vlocity_cmt__ProvisioningStatus__c", "editable": false, "dataType": "STRING", "actions": {} }, "vlocity_cmt__RecurringTotal__c": { "value": 10.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Recurring Total", "hidden": true, "fieldName": "vlocity_cmt__RecurringTotal__c", "editable": false, "dataType": "CURRENCY", "actions": { "pricedetail": { "rest": { "params": {}, "method": "GET", link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z" }, "remote": { "params": { "effectiveAssetsDateFilter": "2017-04-05T07:00:00.000Z", "priceDetailsFields": "vlocity_cmt__RecurringTotal__c", "priceDetail": true, "id": "02i1I00000058doQAA", "accountId": "0011I000007ms8TQAQ", "methodName": "getAssetPriceDetail" } }, "client": { "records": [], "params": {} } } } }, "vlocity_cmt__OneTimeTotal__c": { "value": 100.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Total", "hidden": true, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "actions": { "pricedetail": { "rest": { "params": {}, "method": "GET", link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z" }, "remote": { "params": { "effectiveAssetsDateFilter": "2017-04-05T07:00:00.000Z", "priceDetailsFields": "vlocity_cmt__OneTimeTotal__c", "priceDetail": true, "id": "02i1I00000058doQAA", "accountId": "0011I000007ms8TQAQ", "methodName": "getAssetPriceDetail" } }, "client": { "records": [], "params": {} } } } }, "vlocity_cmt__ContractId__c": { "value": "8001I0000000ThqQAE", "previousValue": null, "originalValue": null, "messages": [], "label": "Contract", "hidden": false, "fieldName": "vlocity_cmt__ContractId__c", "editable": false, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__LineNumber__c": { "value": "0001", "previousValue": null, "originalValue": null, "messages": [], "label": "Line Number", "hidden": true, "fieldName": "vlocity_cmt__LineNumber__c", "editable": false, "dataType": "STRING", "actions": {} }, "vlocity_cmt__RootItemId__c": { "value": "02i1I00000058doQAA", "previousValue": null, "originalValue": null, "messages": [], "label": "RootItemId", "hidden": true, "fieldName": "vlocity_cmt__RootItemId__c", "editable": false, "dataType": "STRING", "actions": {} }, "vlocity_cmt__OneTimeCharge__c": { "value": 100.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Charge", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "actions": { "pricedetail": { "rest": { "params": {}, "method": "GET", link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z" }, "remote": { "params": { "effectiveAssetsDateFilter": "2017-04-05T07:00:00.000Z", "priceDetailsFields": "vlocity_cmt__OneTimeCharge__c", "priceDetail": true, "id": "02i1I00000058doQAA", "accountId": "0011I000007ms8TQAQ", "methodName": "getAssetPriceDetail" } }, "client": { "records": [], "params": {} } } } }, "vlocity_cmt__OneTimeCalculatedPrice__c": { "value": 100.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Calculated Price", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCalculatedPrice__c", "editable": false, "dataType": "CURRENCY", "actions": { "pricedetail": { "rest": { "params": {}, "method": "GET", link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z" }, "remote": { "params": { "effectiveAssetsDateFilter": "2017-04-05T07:00:00.000Z", "priceDetailsFields": "vlocity_cmt__OneTimeCalculatedPrice__c", "priceDetail": true, "id": "02i1I00000058doQAA", "accountId": "0011I000007ms8TQAQ", "methodName": "getAssetPriceDetail" } }, "client": { "records": [], "params": {} } } } }, "vlocity_cmt__OneTimeManualDiscount__c": { "value": 0.00, "previousValue": null, "originalValue": null, "messages": [], "label": "One Time Manual Discount", "hidden": true, "fieldName": "vlocity_cmt__OneTimeManualDiscount__c", "editable": false, "dataType": "PERCENT", "actions": {} }, "vlocity_cmt__RecurringCharge__c": { "value": 10.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Recurring Charge", "hidden": true, "fieldName": "vlocity_cmt__RecurringCharge__c", "editable": false, "dataType": "CURRENCY", "actions": { "pricedetail": { "rest": { "params": {}, "method": "GET", link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z" }, "remote": { "params": { "effectiveAssetsDateFilter": "2017-04-05T07:00:00.000Z", "priceDetailsFields": "vlocity_cmt__RecurringCharge__c", "priceDetail": true, "id": "02i1I00000058doQAA", "accountId": "0011I000007ms8TQAQ", "methodName": "getAssetPriceDetail" } }, "client": { "records": [], "params": {} } } } }, "vlocity_cmt__RecurringCalculatedPrice__c": { "value": 10.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Recurring Calculated Price", "hidden": true, "fieldName": "vlocity_cmt__RecurringCalculatedPrice__c", "editable": false, "dataType": "CURRENCY", "actions": { "pricedetail": { "rest": { "params": {}, "method": "GET", link": "/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z" }, "remote": { "params": { "effectiveAssetsDateFilter": "2017-04-05T07:00:00.000Z", "priceDetailsFields": "vlocity_cmt__RecurringCalculatedPrice__c", "priceDetail": true, "id": "02i1I00000058doQAA", "accountId": "0011I000007ms8TQAQ", "methodName": "getAssetPriceDetail" } }, "client": { "records": [], "params": {} } } } }, "vlocity_cmt__RecurringManualDiscount__c": { "value": 0.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Recurring Manual Discount", "hidden": true, "fieldName": "vlocity_cmt__RecurringManualDiscount__c", "editable": false, "dataType": "PERCENT", "actions": {} }, "vlocity_cmt__ServiceAccountId__c": { "value": "0011I000007ms8TQAQ", "previousValue": null, "originalValue": null, "messages": [], "label": "Service Account", "hidden": false, "fieldName": "vlocity_cmt__ServiceAccountId__c", "editable": false, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__BillingAccountId__c": { "value": "0011I000007ms8TQAQ", "previousValue": null, "originalValue": null, "messages": [], "label": "Billing Account", "hidden": false, "fieldName": "vlocity_cmt__BillingAccountId__c", "editable": false, "dataType": "REFERENCE", "actions": {} }, "vlocity_cmt__PricingLogData__c": { "value": "{\"LogData\":{\"OT_STD_PRC\":[{\"PriceListEntryId\":\"a2X1I0000009iFXUAY\",\"LogType\":\"PRICE\",\"PricingElementGlobalKey\":\"775e358f-31c4-e8de-e23d-e00bbbfedfa6\",\"StartValue\":100.00,\"SubType\":\"Standard\",\"Frequency\":null,\"ChargeTiming\":\"One-time\",\"EndValue\":100.00,\"DisplayText\":\"100$ OTSP\",\"PricingVariableCode\":\"OT_STD_PRC\",\"PricingElementId\":\"a2a1I000000Bar6QAC\",\"PromotionId\":null,\"OfferId\":null,\"PriceListId\":\"a2Y1I000000TlsrUAC\",\"BaseAdjustment\":null,\"BaseValue\":100.00,\"AdjustmentMethod\":null,\"AdjustmentValue\":0.00,\"Amount\":100.00,\"AdjustmentType\":\"None\",\"LogSequence\":0}],\"REC_MNTH_STD_PRC\":[{\"PriceListEntryId\":\"a2X1I0000009iFcUAI\",\"LogType\":\"PRICE\",\"PricingElementGlobalKey\":\"9ef41d53-1bba-017e-625a-b06ac2de2c28\",\"StartValue\":10.00,\"SubType\":\"Standard\",\"Frequency\":\"Monthly\",\"ChargeTiming\":\"Recurring\",\"EndValue\":10.00,\"DisplayText\":\"10$ RMSP\",\"PricingVariableCode\":\"REC_MNTH_STD_PRC\",\"PricingElementId\":\"a2a1I000000Bar1QAC\",\"PromotionId\":null,\"OfferId\":null,\"PriceListId\":\"a2Y1I000000TlsrUAC\",\"BaseAdjustment\":null,\"BaseValue\":10.00,\"AdjustmentMethod\":null,\"AdjustmentValue\":0.00,\"Amount\":10.00,\"AdjustmentType\":\"None\",\"LogSequence\":0}],\"OT_STD_PRC_CALC\":[{\"LogSequence\":0,\"DisplayText\":\"One Time Charge (100.00) - One Time Manual Discount (0.00%)\"}],\"OT_STD_PRC_TOTAL\":[{\"LogSequence\":0,\"DisplayText\":\"[One Time Calculated Price (100.00) + Rollup One Time Total (0.00)] x Quantity (1.00)\"}],\"REC_MNTH_STD_PRC_CALC\":[{\"LogSequence\":0,\"DisplayText\":\"Recurring Charge (10.00) - Recurring Manual Discount (0.00%)\"}],\"REC_MNTH_STD_PRC_TOTAL\":[{\"LogSequence\":0,\"DisplayText\":\"[Recurring Calculated Price (10.00) + Rollup Recurring Total (0.00)] x Quantity (1.00)\"}]},\"PricingVariableCodeFieldBinding\":{\"Quantity\":\"LINE_QUANTITY\",\"vlocity_cmt__EffectiveRecurringTotal__c\":\"EFF_REC_MNTH_STD_PRC_TOTAL\",\"vlocity_cmt__EffectiveOneTimeTotal__c\":\"EFF_OT_STD_PRC_TOTAL\",\"vlocity_cmt__OneTimeCalculatedPrice__c\":\"OT_STD_PRC_CALC\",\"vlocity_cmt__OneTimeManualDiscount__c\":\"OT_STD_PRC_DISC_PCT_MAN\",\"vlocity_cmt__OneTimeCharge__c\":\"OT_STD_PRC\",\"vlocity_cmt__RecurringTotal__c\":\"REC_MNTH_STD_PRC_TOTAL\",\"vlocity_cmt__RecurringCalculatedPrice__c\":\"REC_MNTH_STD_PRC_CALC\",\"vlocity_cmt__RecurringManualDiscount__c\":\"REC_MNTH_STD_PRC_DISC_PCT_MAN\",\"vlocity_cmt__RecurringCharge__c\":\"REC_MNTH_STD_PRC\",\"vlocity_cmt__OneTimeTotal__c\":\"OT_STD_PRC_TOTAL\",\"vlocity_cmt__EffectiveQuantity__c\":\"EFFECTIVE_QUANTITY\"},\"PriceAdjustmentPromoKeys\":[],\"PricingVariableCodeValues\":{\"LINE_QUANTITY\":1.00,\"OT_STD_PRC_DISC_PCT_MAN\":0.00,\"REC_MNTH_STD_PRC_DISC_PCT_MAN\":0.00,\"OT_STD_PRC\":100.00,\"OT_STD_PRC_CALC\":100.00,\"OT_STD_PRC_TOTAL\":100.00,\"REC_MNTH_STD_PRC\":10.00,\"REC_MNTH_STD_PRC_CALC\":10.00,\"REC_MNTH_STD_PRC_TOTAL\":10.00,\"ROLLUP_OT_STD_PRC_TOTAL\":0.00,\"ROLLUP_REC_MNTH_STD_PRC_TOTAL\":0.00,\"EFF_OT_STD_PRC_TOTAL\":100.00,\"EFF_REC_MNTH_STD_PRC_TOTAL\":10.00,\"EFFECTIVE_QUANTITY\":1.00},\"PricingVariableCodeBaseValues\":{\"OT_STD_PRC\":100.00,\"REC_MNTH_STD_PRC\":10.00},\"LogVersion\":\"1.0\",\"LastPricingTime\":\"2017-11-07T10:21:55.572Z\"}", "previousValue": null, "originalValue": null, "messages": [], "label": "Pricing Log", "hidden": true, "fieldName": "vlocity_cmt__PricingLogData__c", "editable": false, "dataType": "TEXTAREA", "actions": {} }, "vlocity_cmt__SequenceNumber__c": { "value": 1, "previousValue": null, "originalValue": null, "messages": [], "label": "Sequence Number", "hidden": true, "fieldName": "vlocity_cmt__SequenceNumber__c", "editable": false, "dataType": "DOUBLE", "actions": {} }, "vlocity_cmt__PricebookEntryId__c": { "value": "01u1I000000ZY4nQAG", "previousValue": null, "originalValue": null, "messages": [], "label": "PricebookEntryId", "hidden": true, "fieldName": "vlocity_cmt__PricebookEntryId__c", "editable": false, "dataType": "STRING", "actions": {} }, "vlocity_cmt__EffectiveQuantity__c": { "value": 1.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Effective Quantity", "hidden": true, "fieldName": "vlocity_cmt__EffectiveQuantity__c", "editable": false, "dataType": "DOUBLE", "actions": {} }, "vlocity_cmt__EffectiveRecurringTotal__c": { "value": 10.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Effective Recurring Total", "hidden": true, "fieldName": "vlocity_cmt__EffectiveRecurringTotal__c", "editable": false, "dataType": "CURRENCY", "actions": {} }, "vlocity_cmt__EffectiveOneTimeTotal__c": { "value": 100.00, "previousValue": null, "originalValue": null, "messages": [], "label": "Effective One Time Total", "hidden": true, "fieldName": "vlocity_cmt__EffectiveOneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "actions": {} }, "Name": "TestA", "promotions": { "totalSize": 0, "messages": [] } }] } ``` ### GET Get Account Info `GET /accounts/{accountid}` Operation ID: `Get Account Information`. Tags: Customer. Get Account properties for a given acount Id. Rest Handler - CpqGetAccountsActionV2 Method Invoked - getAccounts #### Parameters * `accountid` (path, string, required) Customer Account ID (Salesforce ID). _Example_ ``` 001f4000007hynC ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` #### Responses * **200** #### Get Account properties of the specified account id ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "displaySequence": -1, "OwnerId": "0051I000000Qvb4QAC", "Name": "AR3" }] } ``` ### GET Get List of Contracts `GET /accounts/{accountid}/contracts` Operation ID: `Get List of Contracts`. Tags: Customer. Get a list of contracts given account Id. Rest Handler - CpqContractsAccountsActionV2 Method Invoked - getContracts #### Parameters * `accountid` (path, string, required) Customer Account ID (Salesforce ID). _Example_ ``` 001f4000007hynC ``` #### Responses * **200** #### Get list of contracts of the specified account id ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "getassetsbycontract": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt/v2/contracts/8001I0000000ThgQAE/assets" }, "remote": { "params": { "includes": "allAssets" } }, "client": { "params": {} } } }, "displaySequence": -1, "name": "00000364", "Id": { "value": "8001I0000000ThgQAE", "previousValue": null, "originalValue": null, "messages": [], "label": "Id", "hidden": false, "fieldName": "Id", "editable": false, "dataType": "ID", "actions": {} } }] } ``` ### GET Get price details of an asset. `GET /assets/{assetId}/pricing` Operation ID: `Get price details`. Tags: Customer. Get price details of an asset. Rest Handler - APIAssetsPricingV2 Method Invoked - getAssetPriceDetail #### Parameters * `assetId` (path, string, required) Asset ID. _Example_ ``` 02i46000000SyRk ``` * `accountid` (path, string, required) Customer Account ID (Salesforce ID). _Example_ ``` 001f4000007hynC ``` * `effectiveAssetsDateFilter` (query, string) Filters assets based on this date. _Example_ ``` 2017-04-05T07:00:00.000Z ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `hierarchy` (query, integer) Specifies product hierarchy. _Example_ ``` 2 ``` * `include` (query, string) if all assets need to return. _Example_ ``` allAssets ``` #### Responses * **200** OK - API request processed. Look for records. #### Get Asset Price Detail Response Example ```json { "totalSize": 1, "messages": [ ], "records": [ { "messages": [ ], "displaySequence": -1, "id": "02i46000000htMrAAI", "vlocity_cmt__OneTimeCharge__c": { "pricedetail": [ { "actions": { }, "DetailType": "PRICE", "Description": "Product B Base $100 Charge", "StartValue": 100.00, "EndValue": 100.00, "AdjustmentType": "None", "AdjustmentMethod": null, "AdjustmentValue": 0.00 } ] }, "vlocity_cmt__OneTimeCalculatedPrice__c": { "pricedetail": [ { "actions": { }, "DetailType": null, "Description": "One Time Charge (100.00) - One Time Manual Discount (0.00%)", "StartValue": null, "EndValue": null, "AdjustmentType": null, "AdjustmentMethod": null, "AdjustmentValue": null } ] }, "vlocity_cmt__OneTimeTotal__c": { "pricedetail": [ { "actions": { }, "DetailType": null, "Description": "[One Time Calculated Price (100.00) + Rollup One Time Total (0.00)] x Quantity (1.00)", "StartValue": null, "EndValue": null, "AdjustmentType": null, "AdjustmentMethod": null, "AdjustmentValue": null } ] }, "vlocity_cmt__RecurringCharge__c": { "pricedetail": [ { "actions": { }, "DetailType": "PRICE", "Description": "$10 MRC", "StartValue": 10.00, "EndValue": 10.00, "AdjustmentType": "None", "AdjustmentMethod": null, "AdjustmentValue": 0.00 }, { "actions": { }, "DetailType": "ADJUSTMENT", "Description": "Markup applied by Agent", "StartValue": 10.00, "EndValue": 15.0000, "AdjustmentType": "Markup", "AdjustmentMethod": "Percent", "AdjustmentValue": 50.00 } ] }, "vlocity_cmt__RecurringCalculatedPrice__c": { "pricedetail": [ { "actions": { }, "DetailType": null, "Description": "Recurring Charge (15.0000) - Recurring Manual Discount (0.00%)", "StartValue": null, "EndValue": null, "AdjustmentType": null, "AdjustmentMethod": null, "AdjustmentValue": null } ] }, "vlocity_cmt__RecurringTotal__c": { "pricedetail": [ { "actions": { }, "DetailType": null, "Description": "[Recurring Calculated Price (15.00) + Rollup Recurring Total (0.00)] x Quantity (1.00)", "StartValue": null, "EndValue": null, "AdjustmentType": null, "AdjustmentMethod": null, "AdjustmentValue": null } ] } } ] } ``` ### GET Get Asset List `GET /contracts/{contractId}/assets` Operation ID: `Get Asset List`. Tags: Contract. Get a list of assets given contract id. Rest Handler - CpqAssetsContractsActionV2 Method Invoked - getAssetsByContract #### Parameters * `contractId` (path, string, required) Id of Contract for Asset List. _Example_ ``` 800f4000000gLAA ``` * `hierarchy` (query, integer) Specifies product hierarchy. _Example_ ``` 2 ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` * `effectiveAssetsDateFilter` (query, string) An optional date used to filter the effectivity dates for filtering the disconnected assets. If this parameter is not passed in, the API will use the current date and time. _Example_ ``` 2017-04-05T07:00:00.000Z ``` #### Responses * **200** #### Get list of assets of the specified contract id ```json { totalSize: 1 messages: [] records: - messages: [] actions: assetchangesite: rest: params: {} method: POST link: /services/apexrest/vlocity_cmt/v2/carts?subaction=assetChangeSite remote: params: assetList: - 02i1I00000058doQAA moveDate: null toServiceLocation: null fromServiceLocation: null client: params: {} assettoquote: rest: params: {} method: POST link: /services/apexrest/vlocity_cmt/v2/carts?subaction=assetToQuote remote: params: assetList: - 02i1I00000058doQAA requestDate: null client: params: {} assettoorder: rest: params: {} method: POST link: /services/apexrest/vlocity_cmt/v2/carts?subaction=assetToOrder remote: params: assetList: - 02i1I00000058doQAA requestDate: null client: params: {} displaySequence: -1 Id: value: 02i1I00000058doQAA previousValue: null originalValue: null messages: [] label: Asset ID hidden: true fieldName: Id editable: false dataType: ID actions: {} Quantity: value: 1 previousValue: null originalValue: null messages: [] label: Quantity hidden: true fieldName: Quantity editable: false dataType: DOUBLE actions: {} vlocity_cmt__ProvisioningStatus__c: value: Active previousValue: null originalValue: null messages: [] label: Provisioning Status hidden: true fieldName: vlocity_cmt__ProvisioningStatus__c editable: false dataType: STRING actions: {} vlocity_cmt__RecurringTotal__c: value: 10 previousValue: null originalValue: null messages: [] label: Recurring Total hidden: true fieldName: vlocity_cmt__RecurringTotal__c editable: false dataType: CURRENCY actions: pricedetail: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z' remote: params: effectiveAssetsDateFilter: '2017-04-05T07:00:00.000Z' priceDetailsFields: vlocity_cmt__RecurringTotal__c priceDetail: true id: 02i1I00000058doQAA accountId: 0011I000007ms8TQAQ methodName: getAssetPriceDetail client: records: [] params: {} vlocity_cmt__OneTimeTotal__c: value: 100 previousValue: null originalValue: null messages: [] label: One Time Total hidden: true fieldName: vlocity_cmt__OneTimeTotal__c editable: false dataType: CURRENCY actions: pricedetail: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__OneTimeTotal__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z' remote: params: effectiveAssetsDateFilter: '2017-04-05T07:00:00.000Z' priceDetailsFields: vlocity_cmt__OneTimeTotal__c priceDetail: true id: 02i1I00000058doQAA accountId: 0011I000007ms8TQAQ methodName: getAssetPriceDetail client: records: [] params: {} vlocity_cmt__ContractId__c: value: 8001I0000000ThqQAE previousValue: null originalValue: null messages: [] label: Contract hidden: false fieldName: vlocity_cmt__ContractId__c editable: false dataType: REFERENCE actions: {} vlocity_cmt__LineNumber__c: value: '0001' previousValue: null originalValue: null messages: [] label: Line Number hidden: true fieldName: vlocity_cmt__LineNumber__c editable: false dataType: STRING actions: {} vlocity_cmt__RootItemId__c: value: 02i1I00000058doQAA previousValue: null originalValue: null messages: [] label: RootItemId hidden: true fieldName: vlocity_cmt__RootItemId__c editable: false dataType: STRING actions: {} vlocity_cmt__OneTimeCharge__c: value: 100 previousValue: null originalValue: null messages: [] label: One Time Charge hidden: true fieldName: vlocity_cmt__OneTimeCharge__c editable: false dataType: CURRENCY actions: pricedetail: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__OneTimeCharge__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z' remote: params: effectiveAssetsDateFilter: '2017-04-05T07:00:00.000Z' priceDetailsFields: vlocity_cmt__OneTimeCharge__c priceDetail: true id: 02i1I00000058doQAA accountId: 0011I000007ms8TQAQ methodName: getAssetPriceDetail client: records: [] params: {} vlocity_cmt__OneTimeCalculatedPrice__c: value: 100 previousValue: null originalValue: null messages: [] label: One Time Calculated Price hidden: true fieldName: vlocity_cmt__OneTimeCalculatedPrice__c editable: false dataType: CURRENCY actions: pricedetail: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__OneTimeCalculatedPrice__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z' remote: params: effectiveAssetsDateFilter: '2017-04-05T07:00:00.000Z' priceDetailsFields: vlocity_cmt__OneTimeCalculatedPrice__c priceDetail: true id: 02i1I00000058doQAA accountId: 0011I000007ms8TQAQ methodName: getAssetPriceDetail client: records: [] params: {} vlocity_cmt__OneTimeManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: One Time Manual Discount hidden: true fieldName: vlocity_cmt__OneTimeManualDiscount__c editable: false dataType: PERCENT actions: {} vlocity_cmt__RecurringCharge__c: value: 10 previousValue: null originalValue: null messages: [] label: Recurring Charge hidden: true fieldName: vlocity_cmt__RecurringCharge__c editable: false dataType: CURRENCY actions: pricedetail: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringCharge__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z' remote: params: effectiveAssetsDateFilter: '2017-04-05T07:00:00.000Z' priceDetailsFields: vlocity_cmt__RecurringCharge__c priceDetail: true id: 02i1I00000058doQAA accountId: 0011I000007ms8TQAQ methodName: getAssetPriceDetail client: records: [] params: {} vlocity_cmt__RecurringCalculatedPrice__c: value: 10 previousValue: null originalValue: null messages: [] label: Recurring Calculated Price hidden: true fieldName: vlocity_cmt__RecurringCalculatedPrice__c editable: false dataType: CURRENCY actions: pricedetail: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/assets/02i1I00000058doQAA/pricing?accountId=0011I000007ms8TQAQ&priceDetailsFields=vlocity_cmt__RecurringCalculatedPrice__c&effectiveAssetsDateFilter=2017-04-05T07:00:00.000Z' remote: params: effectiveAssetsDateFilter: '2017-04-05T07:00:00.000Z' priceDetailsFields: vlocity_cmt__RecurringCalculatedPrice__c priceDetail: true id: 02i1I00000058doQAA accountId: 0011I000007ms8TQAQ methodName: getAssetPriceDetail client: records: [] params: {} vlocity_cmt__RecurringManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: Recurring Manual Discount hidden: true fieldName: vlocity_cmt__RecurringManualDiscount__c editable: false dataType: PERCENT actions: {} vlocity_cmt__ServiceAccountId__c: value: 0011I000007ms8TQAQ previousValue: null originalValue: null messages: [] label: Service Account hidden: false fieldName: vlocity_cmt__ServiceAccountId__c editable: false dataType: REFERENCE actions: {} vlocity_cmt__BillingAccountId__c: value: 0011I000007ms8TQAQ previousValue: null originalValue: null messages: [] label: Billing Account hidden: false fieldName: vlocity_cmt__BillingAccountId__c editable: false dataType: REFERENCE actions: {} vlocity_cmt__PricingLogData__c: value: '{"LogData":{"OT_STD_PRC":[{"PriceListEntryId":"a2X1I0000009iFXUAY","LogType":"PRICE","PricingElementGlobalKey":"775e358f-31c4-e8de-e23d-e00bbbfedfa6","StartValue":100.00,"SubType":"Standard","Frequency":null,"ChargeTiming":"One-time","EndValue":100.00,"DisplayText":"100$ OTSP","PricingVariableCode":"OT_STD_PRC","PricingElementId":"a2a1I000000Bar6QAC","PromotionId":null,"OfferId":null,"PriceListId":"a2Y1I000000TlsrUAC","BaseAdjustment":null,"BaseValue":100.00,"AdjustmentMethod":null,"AdjustmentValue":0.00,"Amount":100.00,"AdjustmentType":"None","LogSequence":0}],"REC_MNTH_STD_PRC":[{"PriceListEntryId":"a2X1I0000009iFcUAI","LogType":"PRICE","PricingElementGlobalKey":"9ef41d53-1bba-017e-625a-b06ac2de2c28","StartValue":10.00,"SubType":"Standard","Frequency":"Monthly","ChargeTiming":"Recurring","EndValue":10.00,"DisplayText":"10$ RMSP","PricingVariableCode":"REC_MNTH_STD_PRC","PricingElementId":"a2a1I000000Bar1QAC","PromotionId":null,"OfferId":null,"PriceListId":"a2Y1I000000TlsrUAC","BaseAdjustment":null,"BaseValue":10.00,"AdjustmentMethod":null,"AdjustmentValue":0.00,"Amount":10.00,"AdjustmentType":"None","LogSequence":0}],"OT_STD_PRC_CALC":[{"LogSequence":0,"DisplayText":"One Time Charge (100.00) - One Time Manual Discount (0.00%)"}],"OT_STD_PRC_TOTAL":[{"LogSequence":0,"DisplayText":"[One Time Calculated Price (100.00) + Rollup One Time Total (0.00)] x Quantity (1.00)"}],"REC_MNTH_STD_PRC_CALC":[{"LogSequence":0,"DisplayText":"Recurring Charge (10.00) - Recurring Manual Discount (0.00%)"}],"REC_MNTH_STD_PRC_TOTAL":[{"LogSequence":0,"DisplayText":"[Recurring Calculated Price (10.00) + Rollup Recurring Total (0.00)] x Quantity (1.00)"}]},"PricingVariableCodeFieldBinding":{"Quantity":"LINE_QUANTITY","vlocity_cmt__EffectiveRecurringTotal__c":"EFF_REC_MNTH_STD_PRC_TOTAL","vlocity_cmt__EffectiveOneTimeTotal__c":"EFF_OT_STD_PRC_TOTAL","vlocity_cmt__OneTimeCalculatedPrice__c":"OT_STD_PRC_CALC","vlocity_cmt__OneTimeManualDiscount__c":"OT_STD_PRC_DISC_PCT_MAN","vlocity_cmt__OneTimeCharge__c":"OT_STD_PRC","vlocity_cmt__RecurringTotal__c":"REC_MNTH_STD_PRC_TOTAL","vlocity_cmt__RecurringCalculatedPrice__c":"REC_MNTH_STD_PRC_CALC","vlocity_cmt__RecurringManualDiscount__c":"REC_MNTH_STD_PRC_DISC_PCT_MAN","vlocity_cmt__RecurringCharge__c":"REC_MNTH_STD_PRC","vlocity_cmt__OneTimeTotal__c":"OT_STD_PRC_TOTAL","vlocity_cmt__EffectiveQuantity__c":"EFFECTIVE_QUANTITY"},"PriceAdjustmentPromoKeys":[],"PricingVariableCodeValues":{"LINE_QUANTITY":1.00,"OT_STD_PRC_DISC_PCT_MAN":0.00,"REC_MNTH_STD_PRC_DISC_PCT_MAN":0.00,"OT_STD_PRC":100.00,"OT_STD_PRC_CALC":100.00,"OT_STD_PRC_TOTAL":100.00,"REC_MNTH_STD_PRC":10.00,"REC_MNTH_STD_PRC_CALC":10.00,"REC_MNTH_STD_PRC_TOTAL":10.00,"ROLLUP_OT_STD_PRC_TOTAL":0.00,"ROLLUP_REC_MNTH_STD_PRC_TOTAL":0.00,"EFF_OT_STD_PRC_TOTAL":100.00,"EFF_REC_MNTH_STD_PRC_TOTAL":10.00,"EFFECTIVE_QUANTITY":1.00},"PricingVariableCodeBaseValues":{"OT_STD_PRC":100.00,"REC_MNTH_STD_PRC":10.00},"LogVersion":"1.0","LastPricingTime":"2017-11-07T10:21:55.572Z"}' previousValue: null originalValue: null messages: [] label: Pricing Log hidden: true fieldName: vlocity_cmt__PricingLogData__c editable: false dataType: TEXTAREA actions: {} vlocity_cmt__SequenceNumber__c: value: 1 previousValue: null originalValue: null messages: [] label: Sequence Number hidden: true fieldName: vlocity_cmt__SequenceNumber__c editable: false dataType: DOUBLE actions: {} vlocity_cmt__PricebookEntryId__c: value: 01u1I000000ZY4nQAG previousValue: null originalValue: null messages: [] label: PricebookEntryId hidden: true fieldName: vlocity_cmt__PricebookEntryId__c editable: false dataType: STRING actions: {} vlocity_cmt__EffectiveQuantity__c: value: 1 previousValue: null originalValue: null messages: [] label: Effective Quantity hidden: true fieldName: vlocity_cmt__EffectiveQuantity__c editable: false dataType: DOUBLE actions: {} vlocity_cmt__EffectiveRecurringTotal__c: value: 10 previousValue: null originalValue: null messages: [] label: Effective Recurring Total hidden: true fieldName: vlocity_cmt__EffectiveRecurringTotal__c editable: false dataType: CURRENCY actions: {} vlocity_cmt__EffectiveOneTimeTotal__c: value: 100 previousValue: null originalValue: null messages: [] label: Effective One Time Total hidden: true fieldName: vlocity_cmt__EffectiveOneTimeTotal__c editable: false dataType: CURRENCY actions: {} Name: TestA promotions: totalSize: 0 messages: [] } ``` Media type: `application/json`. Schema: `Asset`. ### GET Get Pricelists Available to a Cart `GET /cpq/carts/{cartid}/pricelists` Operation ID: `Get Pricelists`. Tags: Cart. Get pricelists avaialble to a cart Id. Rest Handler CpqGetPriceListsActionV2 Method Invoked getPricelists #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `pagesize` (query, integer) Number of records to be returned. _Example_ ``` 10 ``` #### Responses * **200** #### Get price lists for the cart id ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "setpricelist": { "rest": { "params": { "inputFields": [{ "vlocity_cmt__PriceListId__c": "a2Y1I000000g50kUAA" }] }, "method": "POST", "link": "/services/apexrest/vlocity_cmt__/v2/cpq/carts/8011I000000XegcQAC" }, "remote": { "params": { "inputFields": [{ "vlocity_cmt__PriceListId__c": "a2Y1I000000g50kUAA" }], "cartId": "8011I000000XegcQAC", "methodName": "updateCarts" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": "a2Y1I000000g50kUAA", "Name": "Base PriceList" }] } ``` Media type: `application/json`. Schema: `PriceList`. ### GET Returns Flat List of Field Values. `GET /cpq/carts/{cartid}/price` Operation ID: `Get Carts Line Item`. Tags: Cart. Get Carts Line Item Prices Rest Handler - APIPriceCartsCpqV2 Method Invoked - #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `price` (query, boolean) Indicates whether to run the pricing engine (true) or not (false). Default: `true`. _Example_ ``` true ``` * `priceDetailsFields` (query, string) Comma separated list of fields to retrieve price values for _Example_ ``` vlocity_cmt__OneTimeCharge__c,vlocity_cmt__RecurringCharge__c ``` #### Responses * **200** cart items Media type: `application/json`. Schema: `array of result`. Array of `result`. ### POST Run pricing for given items to a Cart `POST /cpq/carts/{cartid}/price` Operation ID: `Run Price Cart`. Tags: Cart. Run pricing for one or more items to a specified cart. Rest Handler - APIPriceCartsCpqV2 Method Invoked - priceCart. #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `limitScopeToPassedItem` (query, boolean) Introduced in 234.6.2, this flag is used when UOWMode = True. It limits the scope of pricing and evaluating rules to the hierarchies of the items passed in the items parameter. Default value is false. _Example_ ``` true ``` #### Request body Request Body with cartId - required #### Price Cart Request Example ```json { "items": [ "8024600000CHsUa", "8024600000CCpco" ], "validate": true, "limitScopeToPassedItem": true } ``` Media type: `application/json`. Schema: `PriceCartBody`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Media type: `application/json`. Schema: `result`. ### GET Retrieves the price waterfall for a price. `GET /cpq/carts/{cartid}/items/{itemId}/pricing` Operation ID: `Get Pricing Details`. Tags: Cart. This API retrieves the pricing details for a price field based on the cart context (Opportunity, Quote, Order) specified by {cartId} parameter and the line item id {id}. This API is only supported by the PricingElementServiceImplementation. Rest Handler - APIItemsCartsPricingCpqV2 Method Invoked - getPriceDetail #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` * `fields` (query, array of string, collection format: csv) List of fields to return in the response, separated by commas. _Example_ ``` Id,Name ``` #### Responses * **200** #### Response for get price waterfall for a price ```json { "totalSize":1, "messages":[], "records":[{ "messages":[], "displaySequence":-1, "id":"80246000000gZfOAAU", "vlocity_cmt__OneTimeCharge__c": {"pricedetail": [{"actions":{}, "DetailType":"PRICE", "Description":"$50 One Time Standard Price", "StartValue":50, "EndValue":50, "AdjustmentType":"None", "AdjustmentMethod":null, "AdjustmentValue":0 }, {"actions":{}, "DetailType":"ADJUSTMENT", "Description":"5% Discount on OT Std Price due to Bundle A", "StartValue":50, "EndValue":47.5, "AdjustmentType":"Discount", "AdjustmentMethod":"Percent", "AdjustmentValue":-5 }, {"actions":{}, "DetailType":"ADJUSTMENT", "Description":"10% Discount on OT Std Price due to Promotion 'Add Bundle A'", "StartValue":47.5, "EndValue":42.5, "AdjustmentType":"Discount", "AdjustmentMethod":"Percent", "AdjustmentValue":-10 }, {"actions":{}, "DetailType":"ADJUSTMENT", "Description":"Additional 10% - Add Child 2 Promo", "StartValue":42.5, "EndValue":37.5, "AdjustmentType":"Discount", "AdjustmentMethod":"Percent", "AdjustmentValue":-10 } ] } } ]} ``` Media type: `application/json`. Schema: `array of result`. Array of `result`. ### PUT Applies an adjustment (discount, markup, or override to a price). `PUT /cpq/carts/{cartid}/items/{itemId}/pricing` Operation ID: `Apply an Adjustment`. Tags: Cart. This API is used to apply an adjustment (discount, markup, or override) to a price for a line item in the cart (Opportunity, Quote, Order) specified by {cartId} parameter and the line item id {id}. This API updates the existing adjustment record. This API is only supported by the PricingElementServiceImplementation. Rest Handler - APIItemsCartsPricingCpqV2.cls Method Invoked - applyAdjustment #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` #### Request body (required) Request Body with input fields #### Apply Adjustment Request Example ```json PUT /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000gmxY/items/80246000000gXh2/pricing { "adjustments": [ { "AdjustmentValue": -10, "AdjustmentMethod": "Absolute", "DetailType": "ADJUSTMENT", "PricingVariableCode": "OT_STD_PRC", "Field": "vlocity_cmt__OneTimeCharge__c" } ] } ``` Media type: `application/json`. Schema: `result`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. #### Apply Adjustment response ```json { totalSize: 1 messages: [] records: - messages: [] actions: addtocart: rest: params: items: - quantity: 1 parentId: 80246000000hhNzAAI itemId: 01u46000001Z8aCAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: postCartsItems items: - quantity: 1 parentId: 80246000000hhNzAAI itemId: 01u46000001Z8aCAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} updateitems: rest: params: items: - itemId: 80246000000hhNzAAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: putCartsItems items: - itemId: 80246000000hhNzAAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} deleteitem: rest: params: {} method: DELETE link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI?hierarchy=-1&pagesize=20&includeAttachment=false&validate=true&price=true&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI remote: params: methodName: deleteCartsItems id: 80246000000hhNzAAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} cloneitem: rest: params: items: - itemId: 80246000000hhNzAAI id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/clone remote: params: methodName: cloneItems items: - itemId: 80246000000hhNzAAI id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} modifyattributes: rest: params: items: - itemId: 80246000000hhNzAAI filters: null id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/itemAttributes remote: params: methodName: putItemAttributes items: - itemId: 80246000000hhNzAAI filters: null id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: Order Product ID hidden: false fieldName: Id editable: false dataType: ID actions: {} Pricebook2Id: 01s46000003EDDHAA4 Product2Id: 01t46000000Lo2mAAC ProductCode: BUNDLE_A UnitPrice: value: 0 previousValue: null originalValue: null messages: [] label: Unit Price hidden: true fieldName: UnitPrice editable: false dataType: CURRENCY actions: {} Name: Bundle A vlocity_cmt__RecurringPrice__c: 0 IsActive: true Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Description: Bundle A Name: Bundle A vlocity_cmt__IsConfigurable__c: false vlocity_cmt__Type__c: None vlocity_cmt__SubType__c: None RecordTypeId: 01246000000hFtZAAU vlocity_cmt__JSONAttribute__c: null productId: 01t46000000Lo2mAAC defaultQuantity: 1 minQuantity: 0 maxQuantity: 99999 groupMinQuantity: 0 groupMaxQuantity: 99999 sequenceNumber: 1 productChildItemDefinition: attributes: type: vlocity_cmt__ProductChildItem__c url: /services/data/v39.0/sobjects/vlocity_cmt__ProductChildItem__c/a2V46000000cwyhEAA Id: a2V46000000cwyhEAA Name: Root PCI vlocity_cmt__IsVirtualItem__c: false vlocity_cmt__Quantity__c: 1 vlocity_cmt__MaxQuantity__c: 99999 vlocity_cmt__MinQuantity__c: 0 vlocity_cmt__MaximumChildItemQuantity__c: 99999 vlocity_cmt__MinimumChildItemQuantity__c: 0 vlocity_cmt__IsOverride__c: false vlocity_cmt__ParentProductId__c: 01t46000000Lo2mAAC vlocity_cmt__ChildLineNumber__c: '1' vlocity_cmt__SeqNumber__c: 1 vlocity_cmt__CollapseHierarchy__c: false vlocity_cmt__IsRootProductChildItem__c: true vlocity_cmt__ParentProductId__r: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Name: Bundle A productHierarchyPath: 01t46000000Lo2mAAC name: Bundle A isVirtualItem: false provisioningStatus: New hasChildren: true itemType: lineItem PricebookEntryId: value: 01u46000001Z8aCAAS previousValue: null originalValue: null messages: [] label: Price Book Entry ID hidden: false fieldName: PricebookEntryId editable: false dataType: REFERENCE actions: {} Quantity: value: 1 previousValue: null originalValue: null messages: [] label: Quantity hidden: false fieldName: Quantity editable: true dataType: DOUBLE actions: {} vlocity_cmt__OneTimeTotal__c: value: 132.5 previousValue: null originalValue: null messages: [] label: One Time Total hidden: false fieldName: vlocity_cmt__OneTimeTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeTotal__c&PricingVariableCode=OT_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_TOTAL fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringTotal__c: value: 470 previousValue: null originalValue: null messages: [] label: Recurring Total hidden: false fieldName: vlocity_cmt__RecurringTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringTotal__c&PricingVariableCode=REC_MNTH_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_TOTAL fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProvisioningStatus__c: value: New previousValue: null originalValue: null messages: [] label: Provisioning Status hidden: true fieldName: vlocity_cmt__ProvisioningStatus__c editable: false dataType: STRING actions: {} vlocity_cmt__BillingAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Billing Account hidden: false fieldName: vlocity_cmt__BillingAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&lookupField=vlocity_cmt__BillingAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__BillingAccountId__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ServiceAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Service Account hidden: false fieldName: vlocity_cmt__ServiceAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&lookupField=vlocity_cmt__ServiceAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__ServiceAccountId__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProductHierarchyPath__c: value: 01t46000000Lo2mAAC previousValue: null originalValue: null messages: [] label: Product Hierarchy Path hidden: true fieldName: vlocity_cmt__ProductHierarchyPath__c editable: false dataType: STRING actions: {} vlocity_cmt__LineNumber__c: value: '0001' previousValue: null originalValue: null messages: [] label: LineNumber hidden: true fieldName: vlocity_cmt__LineNumber__c editable: false dataType: STRING actions: {} vlocity_cmt__RootItemId__c: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: RootItemId hidden: true fieldName: vlocity_cmt__RootItemId__c editable: false dataType: STRING actions: {} vlocity_cmt__InCartQuantityMap__c: value: 01t46000000Lo2wAAC: 1 previousValue: null originalValue: null messages: [] label: InCartQuantityMap hidden: true fieldName: vlocity_cmt__InCartQuantityMap__c editable: false dataType: TEXTAREA actions: {} ListPrice: value: 0 previousValue: null originalValue: null messages: [] label: List Price hidden: true fieldName: ListPrice editable: false dataType: CURRENCY actions: {} vlocity_cmt__OneTimeCharge__c: value: 100 previousValue: null originalValue: null messages: [] label: One Time Charge hidden: true fieldName: vlocity_cmt__OneTimeCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCharge__c&PricingVariableCode=OT_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeCalculatedPrice__c: value: 100 previousValue: null originalValue: null messages: [] label: One Time Calculated Price hidden: true fieldName: vlocity_cmt__OneTimeCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c&PricingVariableCode=OT_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_CALC fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: One Time Manual Discount hidden: false fieldName: vlocity_cmt__OneTimeManualDiscount__c editable: true dataType: PERCENT actions: {} vlocity_cmt__RecurringCharge__c: value: 20 previousValue: null originalValue: null messages: [] label: Recurring Charge hidden: true fieldName: vlocity_cmt__RecurringCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCharge__c&PricingVariableCode=REC_MNTH_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} timelists: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=TimePlans,TimePolicies' remote: params: methodName: getListsOfValues listkeys: 'TimePlans,TimePolicies' client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringCalculatedPrice__c: value: 20 previousValue: null originalValue: null messages: [] label: Recurring Calculated Price hidden: true fieldName: vlocity_cmt__RecurringCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCalculatedPrice__c&PricingVariableCode=REC_MNTH_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_CALC fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: Recurring Manual Discount hidden: false fieldName: vlocity_cmt__RecurringManualDiscount__c editable: true dataType: PERCENT actions: {} PricebookEntry: attributes: type: PricebookEntry url: /services/data/v39.0/sobjects/PricebookEntry/01u46000001Z8aCAAS Id: 01u46000001Z8aCAAS Product2Id: 01t46000000Lo2mAAC Pricebook2Id: 01s46000003EDDHAA4 Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Name: Bundle A ProductCode: BUNDLE_A vlocity_cmt__Type__c: None vlocity_cmt__IsConfigurable__c: false vlocity_cmt__ServiceAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__BillingAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__Action__c: value: null previousValue: null originalValue: null messages: [] label: Action hidden: false fieldName: vlocity_cmt__Action__c editable: true dataType: PICKLIST actions: {} vlocity_cmt__ParentItemId__c: value: null previousValue: null originalValue: null messages: [] label: ParentItemId hidden: true fieldName: vlocity_cmt__ParentItemId__c editable: false dataType: STRING actions: {} vlocity_cmt__RecurringDiscountPrice__c: value: null previousValue: null originalValue: null messages: [] label: Recurring Discount Price hidden: true fieldName: vlocity_cmt__RecurringDiscountPrice__c editable: false dataType: CURRENCY actions: {} vlocity_cmt__CpqMessageData__c: value: null previousValue: null originalValue: null messages: [] label: Cpq Message Data hidden: true fieldName: vlocity_cmt__CpqMessageData__c editable: true dataType: TEXTAREA actions: {} vlocity_cmt__ItemName__c: value: null previousValue: null originalValue: null messages: [] label: Item Name hidden: false fieldName: vlocity_cmt__ItemName__c editable: true dataType: STRING actions: {} productCategories: totalSize: 0 messages: [] promotions: totalSize: 1 messages: [] records: - messages: [] actions: getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: a2d46000000cq2pAAA Name: Add Bundle A Promo Sequence: 1 lineItems: totalSize: 0 messages: [] records: - messages: [] actions: addtocart: rest: params: items: - quantity: 1 parentId: 80246000000hhO0AAI parentHierarchyPath: 01t46000000Lo2mAAC itemId: 01u46000001Z8aHAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: postCartsItems items: - quantity: 1 parentId: 80246000000hhO0AAI parentHierarchyPath: 01t46000000Lo2mAAC itemId: 01u46000001Z8aHAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} updateitems: rest: params: items: - itemId: 80246000000hhO0AAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: putCartsItems items: - itemId: 80246000000hhO0AAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} deleteitem: rest: params: {} method: DELETE link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI?hierarchy=-1&pagesize=20&includeAttachment=false&validate=true&price=true&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI remote: params: methodName: deleteCartsItems id: 80246000000hhO0AAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} cloneitem: rest: params: items: - itemId: 80246000000hhO0AAI id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/clone remote: params: methodName: cloneItems items: - itemId: 80246000000hhO0AAI id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} modifyattributes: rest: params: items: - itemId: 80246000000hhO0AAI filters: null id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/itemAttributes remote: params: methodName: putItemAttributes items: - itemId: 80246000000hhO0AAI filters: null id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: value: 80246000000hhO0AAI previousValue: null originalValue: null messages: [] label: Order Product ID hidden: false fieldName: Id editable: false dataType: ID actions: {} Pricebook2Id: 01s46000003EDDHAA4 Product2Id: 01t46000000Lo2wAAC ProductCode: PROD_C UnitPrice: value: 0 previousValue: null originalValue: null messages: [] label: Unit Price hidden: true fieldName: UnitPrice editable: false dataType: CURRENCY actions: {} Name: Product C vlocity_cmt__RecurringPrice__c: 0 IsActive: true Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2wAAC Id: 01t46000000Lo2wAAC Description: Product C Name: Product C vlocity_cmt__IsConfigurable__c: false vlocity_cmt__Type__c: None vlocity_cmt__SubType__c: None RecordTypeId: 01246000000hFtZAAU vlocity_cmt__JSONAttribute__c: null productId: 01t46000000Lo2wAAC defaultQuantity: 1 minQuantity: 0 maxQuantity: 2 groupMinQuantity: 0 groupMaxQuantity: 99999 sequenceNumber: 1 productChildItemDefinition: attributes: type: vlocity_cmt__ProductChildItem__c url: /services/data/v39.0/sobjects/vlocity_cmt__ProductChildItem__c/a2V46000000cwywEAA Id: a2V46000000cwywEAA Name: a2V46000000cwyw vlocity_cmt__ChildProductId__c: 01t46000000Lo2wAAC vlocity_cmt__IsVirtualItem__c: false vlocity_cmt__Quantity__c: 1 vlocity_cmt__MaxQuantity__c: 2 vlocity_cmt__MinQuantity__c: 0 vlocity_cmt__MaximumChildItemQuantity__c: 99999 vlocity_cmt__MinimumChildItemQuantity__c: 0 vlocity_cmt__IsOverride__c: false vlocity_cmt__ParentProductId__c: 01t46000000Lo2mAAC vlocity_cmt__ChildLineNumber__c: '1' vlocity_cmt__SeqNumber__c: 1 vlocity_cmt__CollapseHierarchy__c: false vlocity_cmt__IsRootProductChildItem__c: false vlocity_cmt__ChildProductId__r: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2wAAC Id: 01t46000000Lo2wAAC vlocity_cmt__ParentProductId__r: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Name: Bundle A productHierarchyPath: 01t46000000Lo2mAAC<01t46000000Lo2wAAC name: Product C isVirtualItem: false provisioningStatus: New hasChildren: false itemType: lineItem PricebookEntryId: value: 01u46000001Z8aHAAS previousValue: null originalValue: null messages: [] label: Price Book Entry ID hidden: false fieldName: PricebookEntryId editable: false dataType: REFERENCE actions: {} Quantity: value: 1 previousValue: null originalValue: null messages: [] label: Quantity hidden: false fieldName: Quantity editable: true dataType: DOUBLE actions: {} vlocity_cmt__OneTimeTotal__c: value: 32.5 previousValue: null originalValue: null messages: [] label: One Time Total hidden: false fieldName: vlocity_cmt__OneTimeTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeTotal__c&PricingVariableCode=OT_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_TOTAL fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringTotal__c: value: 450 previousValue: null originalValue: null messages: [] label: Recurring Total hidden: false fieldName: vlocity_cmt__RecurringTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringTotal__c&PricingVariableCode=REC_MNTH_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_TOTAL fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProvisioningStatus__c: value: New previousValue: null originalValue: null messages: [] label: Provisioning Status hidden: true fieldName: vlocity_cmt__ProvisioningStatus__c editable: false dataType: STRING actions: {} vlocity_cmt__BillingAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Billing Account hidden: false fieldName: vlocity_cmt__BillingAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&lookupField=vlocity_cmt__BillingAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__BillingAccountId__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ServiceAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Service Account hidden: false fieldName: vlocity_cmt__ServiceAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&lookupField=vlocity_cmt__ServiceAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__ServiceAccountId__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProductHierarchyPath__c: value: 01t46000000Lo2mAAC<01t46000000Lo2wAAC previousValue: null originalValue: null messages: [] label: Product Hierarchy Path hidden: true fieldName: vlocity_cmt__ProductHierarchyPath__c editable: false dataType: STRING actions: {} vlocity_cmt__ParentItemId__c: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: ParentItemId hidden: true fieldName: vlocity_cmt__ParentItemId__c editable: false dataType: STRING actions: {} vlocity_cmt__LineNumber__c: value: 0001.0001 previousValue: null originalValue: null messages: [] label: LineNumber hidden: true fieldName: vlocity_cmt__LineNumber__c editable: false dataType: STRING actions: {} vlocity_cmt__RootItemId__c: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: RootItemId hidden: true fieldName: vlocity_cmt__RootItemId__c editable: false dataType: STRING actions: {} ListPrice: value: 0 previousValue: null originalValue: null messages: [] label: List Price hidden: true fieldName: ListPrice editable: false dataType: CURRENCY actions: {} vlocity_cmt__OneTimeCharge__c: value: 32.5 previousValue: null originalValue: 50 messages: [] label: One Time Charge hidden: true fieldName: vlocity_cmt__OneTimeCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCharge__c&PricingVariableCode=OT_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeCalculatedPrice__c: value: 32.5 previousValue: null originalValue: null messages: [] label: One Time Calculated Price hidden: true fieldName: vlocity_cmt__OneTimeCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c&PricingVariableCode=OT_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_CALC fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: One Time Manual Discount hidden: false fieldName: vlocity_cmt__OneTimeManualDiscount__c editable: true dataType: PERCENT actions: {} vlocity_cmt__RecurringCharge__c: value: 450 previousValue: null originalValue: null messages: [] label: Recurring Charge hidden: true fieldName: vlocity_cmt__RecurringCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCharge__c&PricingVariableCode=REC_MNTH_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} timelists: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=TimePlans,TimePolicies' remote: params: methodName: getListsOfValues listkeys: 'TimePlans,TimePolicies' client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringCalculatedPrice__c: value: 450 previousValue: null originalValue: null messages: [] label: Recurring Calculated Price hidden: true fieldName: vlocity_cmt__RecurringCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCalculatedPrice__c&PricingVariableCode=REC_MNTH_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_CALC fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: Recurring Manual Discount hidden: false fieldName: vlocity_cmt__RecurringManualDiscount__c editable: true dataType: PERCENT actions: {} PricebookEntry: attributes: type: PricebookEntry url: /services/data/v39.0/sobjects/PricebookEntry/01u46000001Z8aHAAS Id: 01u46000001Z8aHAAS Product2Id: 01t46000000Lo2wAAC Pricebook2Id: 01s46000003EDDHAA4 Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2wAAC Id: 01t46000000Lo2wAAC Name: Product C ProductCode: PROD_C vlocity_cmt__Type__c: None vlocity_cmt__IsConfigurable__c: false vlocity_cmt__ServiceAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__BillingAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__Action__c: value: null previousValue: null originalValue: null messages: [] label: Action hidden: false fieldName: vlocity_cmt__Action__c editable: true dataType: PICKLIST actions: {} vlocity_cmt__InCartQuantityMap__c: value: null previousValue: null originalValue: null messages: [] label: InCartQuantityMap hidden: true fieldName: vlocity_cmt__InCartQuantityMap__c editable: false dataType: TEXTAREA actions: {} vlocity_cmt__RecurringDiscountPrice__c: value: null previousValue: null originalValue: null messages: [] label: Recurring Discount Price hidden: true fieldName: vlocity_cmt__RecurringDiscountPrice__c editable: false dataType: CURRENCY actions: {} vlocity_cmt__CpqMessageData__c: value: null previousValue: null originalValue: null messages: [] label: Cpq Message Data hidden: true fieldName: vlocity_cmt__CpqMessageData__c editable: true dataType: TEXTAREA actions: {} vlocity_cmt__ItemName__c: value: null previousValue: null originalValue: null messages: [] label: Item Name hidden: false fieldName: vlocity_cmt__ItemName__c editable: true dataType: STRING actions: {} productCategories: totalSize: 0 messages: [] promotions: totalSize: 1 messages: [] records: - messages: [] actions: getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: a2d46000000cq2pAAA Name: Add Bundle A Promo Sequence: 1 }]}}]}}]} ``` ### POST Applies an adjustment (discount, markup, or override to a price). `POST /cpq/carts/{cartid}/items/{itemId}/pricing` Operation ID: `Apply pricing for items`. Tags: Cart. This API is used to apply an adjustment (discount, markup, or override) to a price for a line item in the cart (Opportunity, Quote, Order) specified by {cartId} parameter and the line item id {id}. This API is only supported by the PricingElementServiceImplementation. Rest Handler - APIItemsCartsPricingCpqV2.cls Method Invoked - applyAdjustment #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` #### Request body (required) Request Body with input fields #### Apply Adjustment Request Example ```json POST /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000gmxY/items/80246000000gXh2/pricing { "adjustments": [ { "AdjustmentValue": -10, "AdjustmentMethod": "Absolute", "DetailType": "ADJUSTMENT", "PricingVariableCode": "OT_STD_PRC", "Field": "vlocity_cmt__OneTimeCharge__c" } ] } ``` Media type: `application/json`. Schema: `result`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. #### Apply Adjustment response ```json { totalSize: 1 messages: [] records: - messages: [] actions: addtocart: rest: params: items: - quantity: 1 parentId: 80246000000hhNzAAI itemId: 01u46000001Z8aCAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: postCartsItems items: - quantity: 1 parentId: 80246000000hhNzAAI itemId: 01u46000001Z8aCAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} updateitems: rest: params: items: - itemId: 80246000000hhNzAAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: putCartsItems items: - itemId: 80246000000hhNzAAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} deleteitem: rest: params: {} method: DELETE link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI?hierarchy=-1&pagesize=20&includeAttachment=false&validate=true&price=true&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI remote: params: methodName: deleteCartsItems id: 80246000000hhNzAAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} cloneitem: rest: params: items: - itemId: 80246000000hhNzAAI id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/clone remote: params: methodName: cloneItems items: - itemId: 80246000000hhNzAAI id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} modifyattributes: rest: params: items: - itemId: 80246000000hhNzAAI filters: null id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/itemAttributes remote: params: methodName: putItemAttributes items: - itemId: 80246000000hhNzAAI filters: null id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: Order Product ID hidden: false fieldName: Id editable: false dataType: ID actions: {} Pricebook2Id: 01s46000003EDDHAA4 Product2Id: 01t46000000Lo2mAAC ProductCode: BUNDLE_A UnitPrice: value: 0 previousValue: null originalValue: null messages: [] label: Unit Price hidden: true fieldName: UnitPrice editable: false dataType: CURRENCY actions: {} Name: Bundle A vlocity_cmt__RecurringPrice__c: 0 IsActive: true Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Description: Bundle A Name: Bundle A vlocity_cmt__IsConfigurable__c: false vlocity_cmt__Type__c: None vlocity_cmt__SubType__c: None RecordTypeId: 01246000000hFtZAAU vlocity_cmt__JSONAttribute__c: null productId: 01t46000000Lo2mAAC defaultQuantity: 1 minQuantity: 0 maxQuantity: 99999 groupMinQuantity: 0 groupMaxQuantity: 99999 sequenceNumber: 1 productChildItemDefinition: attributes: type: vlocity_cmt__ProductChildItem__c url: /services/data/v39.0/sobjects/vlocity_cmt__ProductChildItem__c/a2V46000000cwyhEAA Id: a2V46000000cwyhEAA Name: Root PCI vlocity_cmt__IsVirtualItem__c: false vlocity_cmt__Quantity__c: 1 vlocity_cmt__MaxQuantity__c: 99999 vlocity_cmt__MinQuantity__c: 0 vlocity_cmt__MaximumChildItemQuantity__c: 99999 vlocity_cmt__MinimumChildItemQuantity__c: 0 vlocity_cmt__IsOverride__c: false vlocity_cmt__ParentProductId__c: 01t46000000Lo2mAAC vlocity_cmt__ChildLineNumber__c: '1' vlocity_cmt__SeqNumber__c: 1 vlocity_cmt__CollapseHierarchy__c: false vlocity_cmt__IsRootProductChildItem__c: true vlocity_cmt__ParentProductId__r: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Name: Bundle A productHierarchyPath: 01t46000000Lo2mAAC name: Bundle A isVirtualItem: false provisioningStatus: New hasChildren: true itemType: lineItem PricebookEntryId: value: 01u46000001Z8aCAAS previousValue: null originalValue: null messages: [] label: Price Book Entry ID hidden: false fieldName: PricebookEntryId editable: false dataType: REFERENCE actions: {} Quantity: value: 1 previousValue: null originalValue: null messages: [] label: Quantity hidden: false fieldName: Quantity editable: true dataType: DOUBLE actions: {} vlocity_cmt__OneTimeTotal__c: value: 132.5 previousValue: null originalValue: null messages: [] label: One Time Total hidden: false fieldName: vlocity_cmt__OneTimeTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeTotal__c&PricingVariableCode=OT_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_TOTAL fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringTotal__c: value: 470 previousValue: null originalValue: null messages: [] label: Recurring Total hidden: false fieldName: vlocity_cmt__RecurringTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringTotal__c&PricingVariableCode=REC_MNTH_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_TOTAL fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProvisioningStatus__c: value: New previousValue: null originalValue: null messages: [] label: Provisioning Status hidden: true fieldName: vlocity_cmt__ProvisioningStatus__c editable: false dataType: STRING actions: {} vlocity_cmt__BillingAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Billing Account hidden: false fieldName: vlocity_cmt__BillingAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&lookupField=vlocity_cmt__BillingAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__BillingAccountId__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ServiceAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Service Account hidden: false fieldName: vlocity_cmt__ServiceAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&lookupField=vlocity_cmt__ServiceAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__ServiceAccountId__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProductHierarchyPath__c: value: 01t46000000Lo2mAAC previousValue: null originalValue: null messages: [] label: Product Hierarchy Path hidden: true fieldName: vlocity_cmt__ProductHierarchyPath__c editable: false dataType: STRING actions: {} vlocity_cmt__LineNumber__c: value: '0001' previousValue: null originalValue: null messages: [] label: LineNumber hidden: true fieldName: vlocity_cmt__LineNumber__c editable: false dataType: STRING actions: {} vlocity_cmt__RootItemId__c: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: RootItemId hidden: true fieldName: vlocity_cmt__RootItemId__c editable: false dataType: STRING actions: {} vlocity_cmt__InCartQuantityMap__c: value: 01t46000000Lo2wAAC: 1 previousValue: null originalValue: null messages: [] label: InCartQuantityMap hidden: true fieldName: vlocity_cmt__InCartQuantityMap__c editable: false dataType: TEXTAREA actions: {} ListPrice: value: 0 previousValue: null originalValue: null messages: [] label: List Price hidden: true fieldName: ListPrice editable: false dataType: CURRENCY actions: {} vlocity_cmt__OneTimeCharge__c: value: 100 previousValue: null originalValue: null messages: [] label: One Time Charge hidden: true fieldName: vlocity_cmt__OneTimeCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCharge__c&PricingVariableCode=OT_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeCalculatedPrice__c: value: 100 previousValue: null originalValue: null messages: [] label: One Time Calculated Price hidden: true fieldName: vlocity_cmt__OneTimeCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c&PricingVariableCode=OT_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_CALC fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: One Time Manual Discount hidden: false fieldName: vlocity_cmt__OneTimeManualDiscount__c editable: true dataType: PERCENT actions: {} vlocity_cmt__RecurringCharge__c: value: 20 previousValue: null originalValue: null messages: [] label: Recurring Charge hidden: true fieldName: vlocity_cmt__RecurringCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCharge__c&PricingVariableCode=REC_MNTH_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} timelists: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=TimePlans,TimePolicies' remote: params: methodName: getListsOfValues listkeys: 'TimePlans,TimePolicies' client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringCalculatedPrice__c: value: 20 previousValue: null originalValue: null messages: [] label: Recurring Calculated Price hidden: true fieldName: vlocity_cmt__RecurringCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCalculatedPrice__c&PricingVariableCode=REC_MNTH_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_CALC fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhNzAAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&fields=vlocity_cmt__RecurringCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: Recurring Manual Discount hidden: false fieldName: vlocity_cmt__RecurringManualDiscount__c editable: true dataType: PERCENT actions: {} PricebookEntry: attributes: type: PricebookEntry url: /services/data/v39.0/sobjects/PricebookEntry/01u46000001Z8aCAAS Id: 01u46000001Z8aCAAS Product2Id: 01t46000000Lo2mAAC Pricebook2Id: 01s46000003EDDHAA4 Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Name: Bundle A ProductCode: BUNDLE_A vlocity_cmt__Type__c: None vlocity_cmt__IsConfigurable__c: false vlocity_cmt__ServiceAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__BillingAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__Action__c: value: null previousValue: null originalValue: null messages: [] label: Action hidden: false fieldName: vlocity_cmt__Action__c editable: true dataType: PICKLIST actions: {} vlocity_cmt__ParentItemId__c: value: null previousValue: null originalValue: null messages: [] label: ParentItemId hidden: true fieldName: vlocity_cmt__ParentItemId__c editable: false dataType: STRING actions: {} vlocity_cmt__RecurringDiscountPrice__c: value: null previousValue: null originalValue: null messages: [] label: Recurring Discount Price hidden: true fieldName: vlocity_cmt__RecurringDiscountPrice__c editable: false dataType: CURRENCY actions: {} vlocity_cmt__CpqMessageData__c: value: null previousValue: null originalValue: null messages: [] label: Cpq Message Data hidden: true fieldName: vlocity_cmt__CpqMessageData__c editable: true dataType: TEXTAREA actions: {} vlocity_cmt__ItemName__c: value: null previousValue: null originalValue: null messages: [] label: Item Name hidden: false fieldName: vlocity_cmt__ItemName__c editable: true dataType: STRING actions: {} productCategories: totalSize: 0 messages: [] promotions: totalSize: 1 messages: [] records: - messages: [] actions: getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhNzAAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhNzAAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: a2d46000000cq2pAAA Name: Add Bundle A Promo Sequence: 1 lineItems: totalSize: 0 messages: [] records: - messages: [] actions: addtocart: rest: params: items: - quantity: 1 parentId: 80246000000hhO0AAI parentHierarchyPath: 01t46000000Lo2mAAC itemId: 01u46000001Z8aHAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: postCartsItems items: - quantity: 1 parentId: 80246000000hhO0AAI parentHierarchyPath: 01t46000000Lo2mAAC itemId: 01u46000001Z8aHAAS cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} updateitems: rest: params: items: - itemId: 80246000000hhO0AAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items remote: params: methodName: putCartsItems items: - itemId: 80246000000hhO0AAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} deleteitem: rest: params: {} method: DELETE link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI?hierarchy=-1&pagesize=20&includeAttachment=false&validate=true&price=true&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI remote: params: methodName: deleteCartsItems id: 80246000000hhO0AAI filters: null fields: null cartId: 80146000000h5jmAAA price: true validate: true includeAttachment: false pagesize: 20 lastRecordId: null hierarchy: -1 query: null client: params: {} cloneitem: rest: params: items: - itemId: 80246000000hhO0AAI id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/clone remote: params: methodName: cloneItems items: - itemId: 80246000000hhO0AAI id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} modifyattributes: rest: params: items: - itemId: 80246000000hhO0AAI filters: null id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: PUT link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/itemAttributes remote: params: methodName: putItemAttributes items: - itemId: 80246000000hhO0AAI filters: null id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: value: 80246000000hhO0AAI previousValue: null originalValue: null messages: [] label: Order Product ID hidden: false fieldName: Id editable: false dataType: ID actions: {} Pricebook2Id: 01s46000003EDDHAA4 Product2Id: 01t46000000Lo2wAAC ProductCode: PROD_C UnitPrice: value: 0 previousValue: null originalValue: null messages: [] label: Unit Price hidden: true fieldName: UnitPrice editable: false dataType: CURRENCY actions: {} Name: Product C vlocity_cmt__RecurringPrice__c: 0 IsActive: true Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2wAAC Id: 01t46000000Lo2wAAC Description: Product C Name: Product C vlocity_cmt__IsConfigurable__c: false vlocity_cmt__Type__c: None vlocity_cmt__SubType__c: None RecordTypeId: 01246000000hFtZAAU vlocity_cmt__JSONAttribute__c: null productId: 01t46000000Lo2wAAC defaultQuantity: 1 minQuantity: 0 maxQuantity: 2 groupMinQuantity: 0 groupMaxQuantity: 99999 sequenceNumber: 1 productChildItemDefinition: attributes: type: vlocity_cmt__ProductChildItem__c url: /services/data/v39.0/sobjects/vlocity_cmt__ProductChildItem__c/a2V46000000cwywEAA Id: a2V46000000cwywEAA Name: a2V46000000cwyw vlocity_cmt__ChildProductId__c: 01t46000000Lo2wAAC vlocity_cmt__IsVirtualItem__c: false vlocity_cmt__Quantity__c: 1 vlocity_cmt__MaxQuantity__c: 2 vlocity_cmt__MinQuantity__c: 0 vlocity_cmt__MaximumChildItemQuantity__c: 99999 vlocity_cmt__MinimumChildItemQuantity__c: 0 vlocity_cmt__IsOverride__c: false vlocity_cmt__ParentProductId__c: 01t46000000Lo2mAAC vlocity_cmt__ChildLineNumber__c: '1' vlocity_cmt__SeqNumber__c: 1 vlocity_cmt__CollapseHierarchy__c: false vlocity_cmt__IsRootProductChildItem__c: false vlocity_cmt__ChildProductId__r: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2wAAC Id: 01t46000000Lo2wAAC vlocity_cmt__ParentProductId__r: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2mAAC Id: 01t46000000Lo2mAAC Name: Bundle A productHierarchyPath: 01t46000000Lo2mAAC<01t46000000Lo2wAAC name: Product C isVirtualItem: false provisioningStatus: New hasChildren: false itemType: lineItem PricebookEntryId: value: 01u46000001Z8aHAAS previousValue: null originalValue: null messages: [] label: Price Book Entry ID hidden: false fieldName: PricebookEntryId editable: false dataType: REFERENCE actions: {} Quantity: value: 1 previousValue: null originalValue: null messages: [] label: Quantity hidden: false fieldName: Quantity editable: true dataType: DOUBLE actions: {} vlocity_cmt__OneTimeTotal__c: value: 32.5 previousValue: null originalValue: null messages: [] label: One Time Total hidden: false fieldName: vlocity_cmt__OneTimeTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeTotal__c&PricingVariableCode=OT_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_TOTAL fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringTotal__c: value: 450 previousValue: null originalValue: null messages: [] label: Recurring Total hidden: false fieldName: vlocity_cmt__RecurringTotal__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringTotal__c&PricingVariableCode=REC_MNTH_STD_PRC_TOTAL remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_TOTAL fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_TOTAL AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringTotal__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringTotal__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProvisioningStatus__c: value: New previousValue: null originalValue: null messages: [] label: Provisioning Status hidden: true fieldName: vlocity_cmt__ProvisioningStatus__c editable: false dataType: STRING actions: {} vlocity_cmt__BillingAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Billing Account hidden: false fieldName: vlocity_cmt__BillingAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&lookupField=vlocity_cmt__BillingAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__BillingAccountId__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ServiceAccountId__c: value: 0014600000kAHZKAA4 previousValue: null originalValue: null messages: [] label: Service Account hidden: false fieldName: vlocity_cmt__ServiceAccountId__c editable: true dataType: REFERENCE actions: availablesites: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/sites?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&lookupField=vlocity_cmt__ServiceAccountId__c remote: params: methodName: getAvailableSites lookupField: vlocity_cmt__ServiceAccountId__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__ProductHierarchyPath__c: value: 01t46000000Lo2mAAC<01t46000000Lo2wAAC previousValue: null originalValue: null messages: [] label: Product Hierarchy Path hidden: true fieldName: vlocity_cmt__ProductHierarchyPath__c editable: false dataType: STRING actions: {} vlocity_cmt__ParentItemId__c: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: ParentItemId hidden: true fieldName: vlocity_cmt__ParentItemId__c editable: false dataType: STRING actions: {} vlocity_cmt__LineNumber__c: value: 0001.0001 previousValue: null originalValue: null messages: [] label: LineNumber hidden: true fieldName: vlocity_cmt__LineNumber__c editable: false dataType: STRING actions: {} vlocity_cmt__RootItemId__c: value: 80246000000hhNzAAI previousValue: null originalValue: null messages: [] label: RootItemId hidden: true fieldName: vlocity_cmt__RootItemId__c editable: false dataType: STRING actions: {} ListPrice: value: 0 previousValue: null originalValue: null messages: [] label: List Price hidden: true fieldName: ListPrice editable: false dataType: CURRENCY actions: {} vlocity_cmt__OneTimeCharge__c: value: 32.5 previousValue: null originalValue: 50 messages: [] label: One Time Charge hidden: true fieldName: vlocity_cmt__OneTimeCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCharge__c&PricingVariableCode=OT_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeCalculatedPrice__c: value: 32.5 previousValue: null originalValue: null messages: [] label: One Time Calculated Price hidden: true fieldName: vlocity_cmt__OneTimeCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c&PricingVariableCode=OT_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: OT_STD_PRC_CALC fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: OT_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__OneTimeCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__OneTimeCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__OneTimeManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: One Time Manual Discount hidden: false fieldName: vlocity_cmt__OneTimeManualDiscount__c editable: true dataType: PERCENT actions: {} vlocity_cmt__RecurringCharge__c: value: 450 previousValue: null originalValue: null messages: [] label: Recurring Charge hidden: true fieldName: vlocity_cmt__RecurringCharge__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCharge__c&PricingVariableCode=REC_MNTH_STD_PRC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} timelists: rest: params: {} method: GET link: '/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=TimePlans,TimePolicies' remote: params: methodName: getListsOfValues listkeys: 'TimePlans,TimePolicies' client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCharge__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCharge__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringCalculatedPrice__c: value: 450 previousValue: null originalValue: null messages: [] label: Recurring Calculated Price hidden: true fieldName: vlocity_cmt__RecurringCalculatedPrice__c editable: false dataType: CURRENCY actions: adjustmentcodes: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCalculatedPrice__c&PricingVariableCode=REC_MNTH_STD_PRC_CALC remote: params: methodName: getListsOfValues PricingVariableCode: REC_MNTH_STD_PRC_CALC fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA listkeys: AdjustmentCodes client: records: [] params: {} applyadjustment: rest: params: adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA method: POST link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing remote: params: methodName: applyAdjustment adjustments: - PricingVariableCode: REC_MNTH_STD_PRC_CALC AdjustmentCode: '' AdjustmentValue: 0 AdjustmentMethod: Percent DetailType: ADJUSTMENT Field: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} pricedetail: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/items/80246000000hhO0AAI/pricing?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&fields=vlocity_cmt__RecurringCalculatedPrice__c remote: params: methodName: getPriceDetail fields: vlocity_cmt__RecurringCalculatedPrice__c id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: records: [] params: {} vlocity_cmt__RecurringManualDiscount__c: value: 0 previousValue: null originalValue: null messages: [] label: Recurring Manual Discount hidden: false fieldName: vlocity_cmt__RecurringManualDiscount__c editable: true dataType: PERCENT actions: {} PricebookEntry: attributes: type: PricebookEntry url: /services/data/v39.0/sobjects/PricebookEntry/01u46000001Z8aHAAS Id: 01u46000001Z8aHAAS Product2Id: 01t46000000Lo2wAAC Pricebook2Id: 01s46000003EDDHAA4 Product2: attributes: type: Product2 url: /services/data/v39.0/sobjects/Product2/01t46000000Lo2wAAC Id: 01t46000000Lo2wAAC Name: Product C ProductCode: PROD_C vlocity_cmt__Type__c: None vlocity_cmt__IsConfigurable__c: false vlocity_cmt__ServiceAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__BillingAccountId__r: attributes: type: Account url: /services/data/v39.0/sobjects/Account/0014600000kAHZKAA4 Id: 0014600000kAHZKAA4 Name: Test Account 16 vlocity_cmt__Action__c: value: null previousValue: null originalValue: null messages: [] label: Action hidden: false fieldName: vlocity_cmt__Action__c editable: true dataType: PICKLIST actions: {} vlocity_cmt__InCartQuantityMap__c: value: null previousValue: null originalValue: null messages: [] label: InCartQuantityMap hidden: true fieldName: vlocity_cmt__InCartQuantityMap__c editable: false dataType: TEXTAREA actions: {} vlocity_cmt__RecurringDiscountPrice__c: value: null previousValue: null originalValue: null messages: [] label: Recurring Discount Price hidden: true fieldName: vlocity_cmt__RecurringDiscountPrice__c editable: false dataType: CURRENCY actions: {} vlocity_cmt__CpqMessageData__c: value: null previousValue: null originalValue: null messages: [] label: Cpq Message Data hidden: true fieldName: vlocity_cmt__CpqMessageData__c editable: true dataType: TEXTAREA actions: {} vlocity_cmt__ItemName__c: value: null previousValue: null originalValue: null messages: [] label: Item Name hidden: false fieldName: vlocity_cmt__ItemName__c editable: true dataType: STRING actions: {} productCategories: totalSize: 0 messages: [] promotions: totalSize: 1 messages: [] records: - messages: [] actions: getpromodetails: rest: params: {} method: GET link: /services/apexrest/vlocity_cmt/v2/cpq/carts/80146000000h5jmAAA/promotions?cartId=80146000000h5jmAAA&id=80246000000hhO0AAI&promotionIds=a2F46000000kmtNEAQ&subaction=promodetails remote: params: methodName: getPromotionDetails subaction: promodetails promotionIds: a2F46000000kmtNEAQ id: 80246000000hhO0AAI cartId: 80146000000h5jmAAA client: params: {} displaySequence: -1 Id: a2d46000000cq2pAAA Name: Add Bundle A Promo Sequence: 1 }]}}]}}]} ``` ### DELETE Deletes an existing adjustment. `DELETE /cpq/carts/{cartid}/items/{itemId}/pricing` Operation ID: `Delete an existing adjustment`. Tags: Cart. This API is used to delete an applied adjustment (discount, markup, or override) on a price for a line item in the cart (Opportunity, Quote, Order) specified by {cartId} parameter and the line item id {id}. This API is only supported by the PricingElementServiceImplementation. Rest Handler - APIItemsCartsPricingCpqV2 Method Invoked - deleteAdjustment #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` * `adjustmentId` (query, string) Adjustment Id _Example_ ``` a2H46000000hj2ZEAQ ``` #### Responses * **200** #### Response for Delete Adjustment ```json { totalSize: 1 messages: [] records: - messages: [] displaySequence: -1 id: 02i46000000gusCAAQ nv_cmt_dev__RecurringCharge__c: pricedetail: - actions: {} DetailType: PRICE Description: $10 MRC StartValue: 10 EndValue: 10 AdjustmentType: None AdjustmentMethod: null AdjustmentValue: 0 - actions: {} DetailType: ADJUSTMENT Description: One Day Promo adjustment StartValue: 10 EndValue: 9 AdjustmentType: Discount AdjustmentMethod: Percent AdjustmentValue: -10 }] } } } } } ``` ### GET Expand Parent Item To Display Next Level Children. `GET /cpq/carts/{cartid}/items/{itemId}/expand` Operation ID: `Expand Parent Item`. Tags: Cart. This API retrieves next level of children under a particular product in a bundle (in cart) Rest Handler - APIExpandItemCartsCpqv2 Method Invoked - getExpandedItems #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` * `productHierarchyPath` (query, string) Product hierarchy path of the item getting expanded. _Example_ ``` 01t36000004hM92AAE<01t36000004hM8xAAE ``` #### Responses * **200** #### Get Expanded Cart Items ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "expanditems": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80136000000OXQvAAO/items/80236000009E2InAAK/expand?cartId=80136000000OXQvAAO&itemId=80236000009E2InAAK&productHierarchyPath=01t36000004hM92AAE<01t36000004hM8xAAE" }, "remote": { "params": { "methodName": "getExpandedItems", "productHierarchyPath": "01t36000004hM92AAE<01t36000004hM8xAAE", "itemId": "80236000009E2InAAK", "cartId": "80136000000OXQvAAO" } }, "client": { "params": {} } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u36000009qFdRAAU" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s36000006iLkuAAE" }, "Product2Id": { "label": "Product ID", "value": "01t36000004hM8xAAE" }, "ProductCode": { "label": "Product Code", "value": "es-aug-vhcild1" }, "UnitPrice": { "label": "List Price", "value": null }, "Name": { "label": "Product Name", "value": "es-aug-vhcild1" }, "vlocity_cmt__RecurringPrice__c": { "label": "Recurring Price", "value": null }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t36000004hM8xAAE" }, "Description": "es-aug-vhcild1", "Name": "es-aug-vhcild1", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "Id": "01t36000004hM8xAAE", "vlocity_cmt__JSONAttribute__c": null }, "productId": "01t36000004hM8xAAE", "defaultQuantity": 1.0, "minQuantity": 0.0, "maxQuantity": 99999.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a1x36000002sB2zAAE", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v41.0/sobjects/vlocity_cmt__ProductChildItem__c/a1x36000002sB2zAAE" }, "vlocity_cmt__IsVirtualItem__c": true, "vlocity_cmt__ChildLineNumber__c": "1", "Name": "a1x36000002sB2z", "vlocity_cmt__SeqNumber__c": 1.00, "Id": "a1x36000002sB2zAAE", "vlocity_cmt__ChildProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t36000004hM8xAAE" }, "Name": "es-aug-vhcild1", "Id": "01t36000004hM8xAAE" }, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__ParentProductId__c": "01t36000004hM92AAE", "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__MaxQuantity__c": 99999, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__IsRootProductChildItem__c": false, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t36000004hM92AAE" }, "Name": "es-aug-bundle", "Id": "01t36000004hM92AAE" }, "vlocity_cmt__ChildProductId__c": "01t36000004hM8xAAE", "vlocity_cmt__IsOverride__c": false }, "productHierarchyPath": "01t36000004hM92AAE<01t36000004hM8xAAE", "isVirtualItem": true, "attributeValues": {}, "hasChildren": true, "itemType": "productGroup", "parentLineItemId": "80236000009E2InAAK", "productCategories": { "totalSize": 0, "messages": [] }, "childProducts": { "totalSize": 0, "messages": [], "records": [{ "messages": [], "actions": { "addtocart": { "rest": { "params": { "items": [{ "parentId": "80236000009E2InAAK", "parentHierarchyPath": "01t36000004hM92AAE<01t36000004hM8xAAE", "itemId": "01u36000009qFeFAAU" }], "cartId": "80136000000OXQvAAO", "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "lastRecordId": null, "hierarchy": -1, "query": null }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80136000000OXQvAAO/items" }, "remote": { "params": { "methodName": "postCartsItems", "items": [{ "parentId": "80236000009E2InAAK", "parentHierarchyPath": "01t36000004hM92AAE<01t36000004hM8xAAE", "itemId": "01u36000009qFeFAAU" }], "cartId": "80136000000OXQvAAO", "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "lastRecordId": null, "hierarchy": -1, "query": null } }, "client": { "params": {} } }, "getproductbyid": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80136000000OXQvAAO/products?cartId=80136000000OXQvAAO&id=01u36000009qFeFAAU" }, "remote": { "params": { "methodName": "getCartsProductsById", "id": "01u36000009qFeFAAU", "cartId": "80136000000OXQvAAO" } }, "client": { "params": { "cartId": "80136000000OXQvAAO", "id": "01u36000009qFeFAAU", "methodName": "getCartsProductsById" } } } }, "displaySequence": -1, "Id": { "label": "Price Book Entry ID", "value": "01u36000009qFeFAAU" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01s36000006iLkuAAE" }, "Product2Id": { "label": "Product ID", "value": "01t36000004hM97AAE" }, "ProductCode": { "label": "Product Code", "value": "es-aug-addon1" }, "UnitPrice": { "label": "List Price", "value": null }, "Name": { "label": "Product Name", "value": "es-aug-addon1" }, "vlocity_cmt__RecurringPrice__c": { "label": "Recurring Price", "value": null }, "IsActive": { "label": "Active", "value": true }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t36000004hM97AAE" }, "Description": "es-aug-addon1", "Name": "es-aug-addon1", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "vlocity_cmt__SubType__c": "None", "Id": "01t36000004hM97AAE", "vlocity_cmt__JSONAttribute__c": null }, "productId": "01t36000004hM97AAE", "defaultQuantity": 0.0, "minQuantity": 0.0, "maxQuantity": 5.0, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1.00, "productChildItemId": "a1x36000002sB39AAE", "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c", "url": "/services/data/v41.0/sobjects/vlocity_cmt__ProductChildItem__c/a1x36000002sB39AAE" }, "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__ChildLineNumber__c": "1", "Name": "a1x36000002sB39", "vlocity_cmt__SeqNumber__c": 1.00, "Id": "a1x36000002sB39AAE", "vlocity_cmt__ChildProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t36000004hM97AAE" }, "Name": "es-aug-addon1", "Id": "01t36000004hM97AAE" }, "vlocity_cmt__Quantity__c": 0, "vlocity_cmt__ParentProductId__c": "01t36000004hM8xAAE", "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__MaxQuantity__c": 5, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__IsRootProductChildItem__c": false, "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t36000004hM8xAAE" }, "Name": "es-aug-vhcild1", "Id": "01t36000004hM8xAAE" }, "vlocity_cmt__ChildProductId__c": "01t36000004hM97AAE", "vlocity_cmt__IsOverride__c": false }, "productHierarchyPath": "01t36000004hM92AAE<01t36000004hM8xAAE<01t36000004hM97AAE", "isVirtualItem": false, "attributeValues": {}, "hasChildren": false, "itemType": "childProduct", "productCategories": { "totalSize": 0, "messages": [] } }] } }] } ``` Media type: `application/json`. Schema: `array of result`. Array of `result`. ### PUT Update Item Attributes `PUT /cpq/carts/{cartid}/items/{itemId}/itemattributes` Operation ID: `Update Item Attributes`. Tags: Cart. This API runs the product configuration rules on the updated attribute in the cart. Any changes done as an impact of product configuration rules are returned back as response of this API. Rest Handler - APIItemAttributesItemsCartsCpqV2 Method Invoked - putItemAttributes #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` * `price` (query, boolean) pricing evaluation _Example_ ``` true ``` * `validate` (query, boolean) Indicates whether validation rules are run for the current API request (true) or not (false). Default: `true`. _Example_ ``` true ``` #### Request body (required) Request Body with input fields. #### Update Item Attributes request example ```json { "fields":null, "items":{JSONRECORD}, "itemId":"8021I000001kvWeQAI", "cartId":"8011I000000TOcSQAW", "methodName":"putItemAttributes", "price":true,"validate":true } ``` Media type: `application/json`. Schema: `Item`. #### Responses * **200** #### Response for update item attributes ```json { "methodName": "putItemAttributes", "items": { "records": [{ "attributeCategories": { "totalSize": 1, "messages": [], "records": [{ "messages": [], "displaySequence": 999, "Code__c": "0529CattegoryA", "Name": "0529CattegoryA", "id": "a0941000006fDUjAAM", "productAttributes": { "totalSize": 1, "messages": [], "records": [{ "messages": [], "code": "A_PicklistAttribute_Text", "dataType": "text", "inputType": "dropdown", "multiselect": false, "required": false, "readonly": false, "disabled": false, "filterable": true, "attributeId": "a0A41000005Xp1IEAS", "label": "A_PicklistAttribute_Text", "displaySequence": 1, "hasRules": true, "values": [{ "id": "1", "name": "1", "label": "I am first (label)", "readonly": false, "disabled": false, "value": "1", "defaultSelected": false }, { "id": "2", "name": "2", "label": "I am second (label)", "readonly": false, "disabled": false, "value": "2", "defaultSelected": false }, { "id": "3", "name": "3", "label": "I am third (label)", "readonly": false, "disabled": false, "value": "3", "defaultSelected": false }, { "id": "4", "name": "4", "label": "I am no sequence (label)", "readonly": false, "disabled": false, "value": "4", "defaultSelected": false } ], "userValues": "1" }] } }] }, "Id": { "value": "80241000006AutkAAC", "previousValue": null, "originalValue": null, "messages": [], "label": "Order Product ID", "hidden": false, "fieldName": "Id", "editable": false, "dataType": "ID", "actions": {} }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t410000032V0sAAE" }, "Name": "City2City", "vlocity_cmt_develop__IsConfigurable__c": true, "vlocity_cmt_develop__Type__c": "None", "vlocity_cmt_develop__SubType__c": "None", "Id": "01t410000032V0sAAE", "vlocity_cmt_develop__JSONAttribute__c": null }, "PricebookEntry": { "attributes": { "type": "PricebookEntry", "url": "/services/data/v41.0/sobjects/PricebookEntry/01u41000004eEY1AAM" }, "Product2Id": "01t410000032V0sAAE", "Pricebook2Id": "01s41000007liRQAAY", "Id": "01u41000004eEY1AAM", "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t410000032V0sAAE" }, "Name": "City2City", "Id": "01t410000032V0sAAE", "ProductCode": "City2City", "vlocity_cmt_develop__Type__c": "None", "vlocity_cmt_develop__IsConfigurable__c": true }, "value": { "attributes": { "type": "PricebookEntry", "url": "/services/data/v41.0/sobjects/PricebookEntry/01u41000004eEY1AAM" }, "Product2Id": "01t410000032V0sAAE", "Id": "01u41000004eEY1AAM", "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v41.0/sobjects/Product2/01t410000032V0sAAE" }, "Name": "City2City", "Id": "01t410000032V0sAAE" } } }, "PricebookEntryId": { "value": "01u41000004eEY1AAM", "previousValue": null, "originalValue": null, "messages": [], "label": "Price Book Entry ID", "hidden": false, "fieldName": "PricebookEntryId", "editable": false, "dataType": "REFERENCE", "actions": {} } }] }, "filters": null, "itemId": "80241000006AutkAAC", "id": "80241000006AutkAAC", "cartId": "80141000002H2ILAA0", "price": true, "validate": true } ``` Media type: `application/json`. Schema: `array of result`. Array of `result`. ### POST Clones line items in the cart. `POST /cpq/carts/{cartid}/items/clone` Operation ID: `Clones line items`. Tags: Cart. Clones line items in the cart. #### Parameters * `cartid` (path, string, required) Cart ID (Salesforce ID). Opportunity, Quote or Order ID. _Example_ ``` 801360000000oQ9 ``` * `itemId` (path, string, required) Line Item ID under the cart. _Example_ ``` 80236000009E2InAAK ``` #### Request body (required) Request Body with input fields. #### Clone root line item request example ```json { "methodName": "cloneItems", "cartId": "801360000008eNU", "items":[ {"itemId":"01t36000000pfcKAAQ"}] } ``` #### Clone child line item request example ```json { "methodName": "cloneItems", "cartId": "8014T000000rXVo", "items": [ { "itemId": "8024T000000hVrX", "parentRecord": { "records": [ { "Id": "8024T000000hVaj", "productId": "01t4T000000WTjwQAG", "productHierarchyPath": "01t4T000000WTjwQAG", "itemType": "lineItem", "parentLineItemId": "8024T000000hVaj" } ] } } ] } ``` Media type: `application/json`. Schema: `Item`. #### Responses * **200** #### Clone root line items ```json { "totalSize" => 1, "messages" => [{ "severity" => "INFO", "messageId" => nil, "message" => "Clone Successful.", "code" => "153", "bundleId" => nil, "actions" => {} }], "actions" => { "itempricesupdated" => { "rest" => { "params" => {}, "method" => "GET", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/price" }, "remote" => { "params" => { "cartId" => "8016A000000bwDJQAY", "methodName" => "getCartLineItemPrices" } }, "client" => { "params" => {} } } }, "records" => [{ "messages" => [], "actions" => { "addtocart" => { "rest" => { "params" => { "items" => [{ "quantity" => 1, "parentId" => "8026A000000cCaQQAU", "itemId" => "01u6A00000135XeQAI" }], "cartId" => "8016A000000bwDJQAY", "price" => true, "validate" => true, "includeAttachment" => false, "pagesize" => 20, "lastRecordId" => nil, "hierarchy" => -1, "query" => nil }, "method" => "POST", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items" }, "remote" => { "params" => { "methodName" => "postCartsItems", "items" => [{ "quantity" => 1, "parentId" => "8026A000000cCaQQAU", "itemId" => "01u6A00000135XeQAI" }], "cartId" => "8016A000000bwDJQAY", "price" => true, "validate" => true, "includeAttachment" => false, "pagesize" => 20, "lastRecordId" => nil, "hierarchy" => -1, "query" => nil } }, "client" => { "params" => {} } }, "updateitems" => { "rest" => { "params" => { "items" => [{ "itemId" => "8026A000000cCaQQAU" }], "filters" => nil, "fields" => nil, "cartId" => "8016A000000bwDJQAY", "price" => true, "validate" => true, "includeAttachment" => false, "pagesize" => 20, "lastRecordId" => nil, "hierarchy" => -1, "query" => nil }, "method" => "PUT", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items" }, "remote" => { "params" => { "methodName" => "putCartsItems", "items" => [{ "itemId" => "8026A000000cCaQQAU" }], "filters" => nil, "fields" => nil, "cartId" => "8016A000000bwDJQAY", "price" => true, "validate" => true, "includeAttachment" => false, "pagesize" => 20, "lastRecordId" => nil, "hierarchy" => -1, "query" => nil } }, "client" => { "params" => {} } }, "deleteitem" => { "rest" => { "params" => {}, "method" => "DELETE", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items/8026A000000cCaQQAU?hierarchy=-1&pagesize=20&includeAttachment=false&validate=true&price=true&cartId=8016A000000bwDJQAY&id=8026A000000cCaQQAU" }, "remote" => { "params" => { "methodName" => "deleteCartsItems", "id" => "8026A000000cCaQQAU", "filters" => nil, "fields" => nil, "cartId" => "8016A000000bwDJQAY", "price" => true, "validate" => true, "includeAttachment" => false, "pagesize" => 20, "lastRecordId" => nil, "hierarchy" => -1, "query" => nil } }, "client" => { "params" => {} } }, "cloneitem" => { "rest" => { "params" => { "items" => [{ "itemId" => "8026A000000cCaQQAU" }], "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" }, "method" => "POST", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items/clone" }, "remote" => { "params" => { "methodName" => "cloneItems", "items" => [{ "itemId" => "8026A000000cCaQQAU" }], "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" } }, "client" => { "params" => {} } }, "modifyattributes" => { "rest" => { "params" => { "items" => [{ "itemId" => "8026A000000cCaQQAU" }], "filters" => nil, "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" }, "method" => "PUT", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items/8026A000000cCaQQAU/itemAttributes" }, "remote" => { "params" => { "methodName" => "putItemAttributes", "items" => [{ "itemId" => "8026A000000cCaQQAU" }], "filters" => nil, "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" } }, "client" => { "params" => {} } } }, "displaySequence" => -1, "Id" => { "value" => "8026A000000cCaQQAU", "previousValue" => nil, "originalValue" => nil, "messages" => [], "label" => "Order Product ID", "hidden" => false, "fieldName" => "Id", "editable" => false, "dataType" => "ID", "actions" => {} }, "Pricebook2Id" => "01s6A0000037JCtQAM", "Product2Id" => "01t6A000000fd0AQAQ", "ProductCode" => "IRKPL", "UnitPrice" => { "value" => 0.0, "previousValue" => nil, "originalValue" => nil, "messages" => [], "label" => "Unit Price", "hidden" => true, "fieldName" => "UnitPrice", "editable" => false, "dataType" => "CURRENCY", "actions" => {} }, "Name" => "IRKPL", "vlocity_cmt__RecurringPrice__c" => 0.0, "IsActive" => true, "Product2" => { "attributes" => { "type" => "Product2", "url" => "/services/data/v40.0/sobjects/Product2/01t6A000000fd0AQAQ" }, "Name" => "IRKPL", "vlocity_cmt__IsConfigurable__c" => false, "vlocity_cmt__Type__c" => "None", "vlocity_cmt__SubType__c" => "None", "RecordTypeId" => "0126A000000gwBfQAI", "Id" => "01t6A000000fd0AQAQ", "vlocity_cmt__JSONAttribute__c" => nil }, "productId" => "01t6A000000fd0AQAQ", "defaultQuantity" => 1.0, "minQuantity" => 0.0, "maxQuantity" => 99999.0, "groupMinQuantity" => 0, "groupMaxQuantity" => 99999, "sequenceNumber" => 1.0, "productChildItemDefinition" => { "attributes" => { "type" => "vlocity_cmt__ProductChildItem__c", "url" => "/services/data/v40.0/sobjects/vlocity_cmt__ProductChildItem__c/a2a6A000000wm6XQAQ" }, "vlocity_cmt__MinQuantity__c" => 0, "vlocity_cmt__SeqNumber__c" => 1.0, "Name" => "Root PCI", "Id" => "a2a6A000000wm6XQAQ", "vlocity_cmt__Quantity__c" => 1, "vlocity_cmt__MaximumChildItemQuantity__c" => 99999, "vlocity_cmt__MaxQuantity__c" => 99999, "vlocity_cmt__ParentProductId__r" => { "attributes" => { "type" => "Product2", "url" => "/services/data/v40.0/sobjects/Product2/01t6A000000fd0AQAQ" }, "Name" => "IRKPL", "Id" => "01t6A000000fd0AQAQ", "RecordTypeId" => "0126A000000gwBfQAI" }, "vlocity_cmt__MinimumChildItemQuantity__c" => 0, "vlocity_cmt__CollapseHierarchy__c" => false, "vlocity_cmt__IsOverride__c" => false, "vlocity_cmt__IsVirtualItem__c" => false, "vlocity_cmt__ChildLineNumber__c" => "1", "vlocity_cmt__IsRootProductChildItem__c" => true, "vlocity_cmt__ParentProductId__c" => "01t6A000000fd0AQAQ" }, "productHierarchyPath" => "01t6A000000fd0AQAQ", "name" => "IRKPL", "isVirtualItem" => false, "provisioningStatus" => "New", "hasChildren" => false, "itemType" => "lineItem", "PricebookEntryId" => { "value" => "01u6A00000135XeQAI", "previousValue" => nil, "originalValue" => nil, "messages" => [], "label" => "Price Book Entry ID", "hidden" => false, "fieldName" => "PricebookEntryId", "editable" => false, "dataType" => "REFERENCE", "actions" => {} }, "Quantity" => { "value" => 1.0, "previousValue" => nil, "originalValue" => nil, "messages" => [], "label" => "Quantity", "hidden" => false, "fieldName" => "Quantity", "editable" => true, "dataType" => "DOUBLE", "actions" => {} }, "vlocity_cmt__OneTimeTotal__c" => { "value" => 10.0, "previousValue" => nil, "originalValue" => nil, "messages" => [], "label" => "One Time Total", "hidden" => false, "fieldName" => "vlocity_cmt__OneTimeTotal__c", "editable" => false, "dataType" => "CURRENCY", "actions" => { "adjustmentcodes" => { "rest" => { "params" => {}, "method" => "GET", "link" => "/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=8016A000000bwDJQAY&id=8026A000000cCaQQAU&fields=vlocity_cmt__OneTimeTotal__c&PricingVariableCode=OT_STD_PRC_TOTAL" }, "remote" => { "params" => { "methodName" => "getListsOfValues", "PricingVariableCode" => "OT_STD_PRC_TOTAL", "fields" => "vlocity_cmt__OneTimeTotal__c", "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY", "listkeys" => "AdjustmentCodes" } }, "client" => { "records" => [], "params" => {} } }, "applyadjustment" => { "rest" => { "params" => { "adjustments" => [{ "PricingVariableCode" => "OT_STD_PRC_TOTAL", "AdjustmentCode" => "", "AdjustmentValue" => 0, "AdjustmentMethod" => "Percent", "DetailType" => "ADJUSTMENT", "Field" => "vlocity_cmt__OneTimeTotal__c" }], "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" }, "method" => "POST", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items/8026A000000cCaQQAU/pricing" }, "remote" => { "params" => { "methodName" => "applyAdjustment", "adjustments" => [{ "PricingVariableCode" => "OT_STD_PRC_TOTAL", "AdjustmentCode" => "", "AdjustmentValue" => 0, "AdjustmentMethod" => "Percent", "DetailType" => "ADJUSTMENT", "Field" => "vlocity_cmt__OneTimeTotal__c" }], "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" } }, "client" => { "records" => [], "params" => {} } }, "pricedetail" => { "rest" => { "params" => {}, "method" => "GET", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items/8026A000000cCaQQAU/pricing?cartId=8016A000000bwDJQAY&id=8026A000000cCaQQAU&fields=vlocity_cmt__OneTimeTotal__c" }, "remote" => { "params" => { "methodName" => "getPriceDetail", "fields" => "vlocity_cmt__OneTimeTotal__c", "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" } }, "client" => { "records" => [], "params" => {} } } } }, "vlocity_cmt__RecurringTotal__c" => { "value" => 0.0, "previousValue" => nil, "originalValue" => nil, "messages" => [], "label" => "Recurring Total", "hidden" => false, "fieldName" => "vlocity_cmt__RecurringTotal__c", "editable" => false, "dataType" => "CURRENCY", "actions" => { "adjustmentcodes" => { "rest" => { "params" => {}, "method" => "GET", "link" => "/services/apexrest/vlocity_cmt/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=8016A000000bwDJQAY&id=8026A000000cCaQQAU&fields=vlocity_cmt__RecurringTotal__c&PricingVariableCode=REC_MNTH_STD_PRC_TOTAL" }, "remote" => { "params" => { "methodName" => "getListsOfValues", "PricingVariableCode" => "REC_MNTH_STD_PRC_TOTAL", "fields" => "vlocity_cmt__RecurringTotal__c", "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY", "listkeys" => "AdjustmentCodes" } }, "client" => { "records" => [], "params" => {} } }, "applyadjustment" => { "rest" => { "params" => { "adjustments" => [{ "PricingVariableCode" => "REC_MNTH_STD_PRC_TOTAL", "AdjustmentCode" => "", "AdjustmentValue" => 0, "AdjustmentMethod" => "Percent", "DetailType" => "ADJUSTMENT", "Field" => "vlocity_cmt__RecurringTotal__c" }], "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" }, "method" => "POST", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items/8026A000000cCaQQAU/pricing" }, "remote" => { "params" => { "methodName" => "applyAdjustment", "adjustments" => [{ "PricingVariableCode" => "REC_MNTH_STD_PRC_TOTAL", "AdjustmentCode" => "", "AdjustmentValue" => 0, "AdjustmentMethod" => "Percent", "DetailType" => "ADJUSTMENT", "Field" => "vlocity_cmt__RecurringTotal__c" }], "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" } }, "client" => { "records" => [], "params" => {} } }, "pricedetail" => { "rest" => { "params" => {}, "method" => "GET", "link" => "/services/apexrest/vlocity_cmt/v2/cpq/carts/8016A000000bwDJQAY/items/8026A000000cCaQQAU/pricing?cartId=8016A000000bwDJQAY&id=8026A000000cCaQQAU&fields=vlocity_cmt__RecurringTotal__c" }, "remote" => { "params" => { "methodName" => "getPriceDetail", "fields" => "vlocity_cmt__RecurringTotal__c", "id" => "8026A000000cCaQQAU", "cartId" => "8016A000000bwDJQAY" } }, "client" => { "records" => [], "params" => {} } } } }, } ``` #### Clone child line items ```json { "totalSize": 1, "messages": [ { "code": "153", "severity": "INFO", "message": "Successfully added." } ], "actions": { "itempricesupdated": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/price?price=false" }, "remote": { "params": { "price": false, "cartId": "8014T000000rXVoQAM", "methodName": "getCartLineItemPrices" } }, "client": { "params": { } } } }, "records": [ { "messages": [ ], "actions": { "addtocart": { "rest": { "params": { "items": [ { "quantity": 1, "itemId": "01u4T000000zC6kQAE" } ], "cartId": "8014T000000rXVoQAM", "price": true, "validate": true, "includeAttachment": true, "pagesize": 20, "lastRecordId": null, "hierarchy": -1, "query": null }, "method": "POST", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items" }, "remote": { "params": { } }, "client": { "params": { } } }, "updateitems": { "rest": { "params": { "items": [ { "itemId": "8024T000000hVajQAE" } ], "filters": null, "fields": null, "cartId": "8014T000000rXVoQAM", "price": true, "validate": true, "includeAttachment": true, "pagesize": 20, "lastRecordId": null, "hierarchy": -1, "query": null }, "method": "PUT", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items" }, "remote": { "params": { } }, "client": { "params": { } } }, "deleteitem": { "rest": { "params": { }, "method": "DELETE", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVajQAE?hierarchy=-1&pagesize=20&includeAttachment=true&validate=true&price=true&cartId=8014T000000rXVoQAM&id=8024T000000hVajQAE" }, "remote": { "params": { } }, "client": { "params": { } } }, "configdelete": { "rest": { "params": { }, "method": null, "link": null }, "remote": { "params": { } }, "client": { "params": { } } }, "cloneitem": { "rest": { "params": { "items": [ { "itemId": "8024T000000hVajQAE" } ], "id": "8024T000000hVajQAE", "cartId": "8014T000000rXVoQAM" }, "method": "POST", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/clone" }, "remote": { "params": { } }, "client": { "params": { } } }, "modifyattributes": { "rest": { "params": { "items": [ { "itemId": "8024T000000hVajQAE" } ], "filters": null, "itemId": "8024T000000hVajQAE", "id": "8024T000000hVajQAE", "cartId": "8014T000000rXVoQAM" }, "method": "PUT", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVajQAE/itemAttributes" }, "remote": { "params": { } }, "client": { "params": { } } } }, "displaySequence": -1, "Id": { "value": "8024T000000hVajQAE", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Order Product ID", "hidden": false, "fieldName": "Id", "editable": false, "dataType": "ID", "alternateValues": null, "actions": { } }, "name": "TEST Offer", "productId": "01t4T000000WTjwQAG", "vlocity_cmt__InCartQuantityMap__c": { "value": { "01t4T000000WTkBQAW": 2, "01t4T000000WTkGQAW": 1 }, "previousValue": null, "originalValue": null, "messages": [ ], "label": "InCartQuantityMap", "hidden": true, "fieldName": "vlocity_cmt__InCartQuantityMap__c", "editable": false, "dataType": "TEXTAREA", "alternateValues": null, "actions": { } }, "isVirtualItem": false, "lineItems": { "totalSize": 0, "messages": [ ], "records": [ { "messages": [ ], "actions": { "addtocart": { "rest": { "params": { "items": [ { "quantity": 1, "parentId": "8024T000000hVajQAE", "parentHierarchyPath": "01t4T000000WTjwQAG", "itemId": "01u4T000000zC74QAE" } ], "cartId": "8014T000000rXVoQAM", "price": true, "validate": true, "includeAttachment": true, "pagesize": 20, "lastRecordId": null, "hierarchy": -1, "query": null }, "method": "POST", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items" }, "remote": { "params": { } }, "client": { "params": { } } }, "updateitems": { "rest": { "params": { "items": [ { "itemId": "8024T000000hVrcQAE" } ], "filters": null, "fields": null, "cartId": "8014T000000rXVoQAM", "price": true, "validate": true, "includeAttachment": true, "pagesize": 20, "lastRecordId": null, "hierarchy": -1, "query": null }, "method": "PUT", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items" }, "remote": { "params": { } }, "client": { "params": { } } }, "deleteitem": { "rest": { "params": { }, "method": "DELETE", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVrcQAE?hierarchy=-1&pagesize=20&includeAttachment=true&validate=true&price=true&cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE" }, "remote": { "params": { } }, "client": { "params": { } } }, "configdelete": { "rest": { "params": { }, "method": null, "link": null }, "remote": { "params": { } }, "client": { "params": { } } }, "cloneitem": { "rest": { "params": { "items": [ { "itemId": "8024T000000hVrcQAE" } ], "id": "8024T000000hVrcQAE", "cartId": "8014T000000rXVoQAM" }, "method": "POST", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/clone" }, "remote": { "params": { } }, "client": { "params": { } } }, "modifyattributes": { "rest": { "params": { "items": [ { "itemId": "8024T000000hVrcQAE" } ], "filters": null, "itemId": "8024T000000hVrcQAE", "id": "8024T000000hVrcQAE", "cartId": "8014T000000rXVoQAM" }, "method": "PUT", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVrcQAE/itemAttributes" }, "remote": { "params": { } }, "client": { "params": { } } } }, "displaySequence": -1, "UnitPrice": { "value": 0.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "Unit Price", "hidden": true, "fieldName": "UnitPrice", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": { } }, "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v50.0/sobjects/Product2/01t4T000000WTkBQAW" }, "vlocity_cmt__Type__c": "None", "vlocity_cmt__IsConfigurable__c": false, "Name": "Test Internet 2", "Id": "01t4T000000WTkBQAW", "vlocity_cmt__SubType__c": "None", "IsActive": true, "vlocity_cmt__SpecificationType__c": "Offer", "vlocity_cmt__GlobalGroupKey__c": "eb006d2e-e816-7a0e-4060-2bed6511be52", "vlocity_cmt__ProductSpecId__c": "01t4T000000WTk1QAG", "ProductCode": "TEST-OFFERSPEC-003", "RecordTypeId": "0124T000000PFWfQAO", "vlocity_cmt__ProductSpecId__r": { "attributes": { "type": "Product2", "url": "/services/data/v50.0/sobjects/Product2/01t4T000000WTk1QAG" }, "ProductCode": "Test-Product-Specification-01", "Name": "Test Product Specification", "Id": "01t4T000000WTk1QAG", "RecordTypeId": "0124T000000PFWfQAO", "vlocity_cmt__SpecificationType__c": "Product" }, "vlocity_cmt__AttributeMetadata__c": null, "vlocity_cmt__AttributeDefaultValues__c": null }, "vlocity_cmt__RecurringPrice__c": 0.00, "Name": "Test Internet 2", "Id": { "value": "8024T000000hVrcQAE", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Order Product ID", "hidden": false, "fieldName": "Id", "editable": false, "dataType": "ID", "alternateValues": null, "actions": { } }, "Product2Id": "01t4T000000WTkBQAW", "IsActive": true, "ProductCode": "TEST-OFFERSPEC-003", "Pricebook2Id": "01s4T000000PYMyQAO", "PricebookEntry": { "attributes": { "type": "PricebookEntry", "url": "/services/data/v50.0/sobjects/PricebookEntry/01u4T000000zC74QAE" }, "Id": "01u4T000000zC74QAE", "Pricebook2Id": "01s4T000000PYMyQAO", "Product2Id": "01t4T000000WTkBQAW", "Product2": { "attributes": { "type": "Product2", "url": "/services/data/v50.0/sobjects/Product2/01t4T000000WTkBQAW" }, "Id": "01t4T000000WTkBQAW", "vlocity_cmt__GlobalGroupKey__c": "eb006d2e-e816-7a0e-4060-2bed6511be52", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__Type__c": "None", "Name": "Test Internet 2", "ProductCode": "TEST-OFFERSPEC-003" } }, "productId": "01t4T000000WTkBQAW", "defaultQuantity": 1, "minQuantity": 0, "maxQuantity": 5, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 2.00, "productChildItemDefinition": { "attributes": { "type": "vlocity_cmt__ProductChildItem__c" }, "vlocity_cmt__SeqNumber__c": 2.00, "vlocity_cmt__IsVirtualItem__c": false, "vlocity_cmt__Quantity__c": 1, "vlocity_cmt__CollapseHierarchy__c": false, "vlocity_cmt__ChildProductId__c": "01t4T000000WTkBQAW", "vlocity_cmt__MinQuantity__c": 0, "vlocity_cmt__IsOverride__c": false, "vlocity_cmt__ParentProductId__c": "01t4T000000WTjwQAG", "Name": "a354T000000dq2j", "vlocity_cmt__ChildProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v50.0/sobjects/Product2/01t4T000000WTkBQAW" }, "Name": "Test Internet 2", "Id": "01t4T000000WTkBQAW", "RecordTypeId": "0124T000000PFWfQAO", "vlocity_cmt__GlobalGroupKey__c": "eb006d2e-e816-7a0e-4060-2bed6511be52", "vlocity_cmt__ProductSpecId__c": "01t4T000000WTk1QAG" }, "vlocity_cmt__ChildLineNumber__c": "2", "vlocity_cmt__MinimumChildItemQuantity__c": 0, "vlocity_cmt__IsRootProductChildItem__c": false, "vlocity_cmt__ParentProductId__r": { "attributes": { "type": "Product2", "url": "/services/data/v50.0/sobjects/Product2/01t4T000000WTjwQAG" }, "Name": "TEST Offer", "Id": "01t4T000000WTjwQAG", "RecordTypeId": "0124T000000PFWfQAO", "vlocity_cmt__GlobalGroupKey__c": "40a771b8-f4f4-5e12-81ec-47b822007a7c" }, "vlocity_cmt__MaximumChildItemQuantity__c": 99999, "vlocity_cmt__MaxQuantity__c": 5 }, "productHierarchyPath": "01t4T000000WTjwQAG<01t4T000000WTkBQAW", "name": "Test Internet 2", "isVirtualItem": false, "hasChildren": false, "orderActive": false, "itemType": "lineItem", "action": "Add", "SellingPeriod": "Present", "ListPrice": { "value": 0.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "List Price", "hidden": true, "fieldName": "ListPrice", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": { } }, "OrderId": { "value": "8014T000000rXVoQAM", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Order ID", "hidden": false, "fieldName": "OrderId", "editable": false, "dataType": "REFERENCE", "alternateValues": null, "actions": { } }, "PricebookEntryId": { "value": "01u4T000000zC74QAE", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Price Book Entry ID", "hidden": false, "fieldName": "PricebookEntryId", "editable": false, "dataType": "REFERENCE", "alternateValues": null, "actions": { } }, "Quantity": { "value": 1.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "Quantity", "hidden": false, "fieldName": "Quantity", "editable": true, "dataType": "DOUBLE", "alternateValues": null, "actions": { } }, "vlocity_cmt__Action__c": { "value": "Add", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Action", "hidden": false, "fieldName": "vlocity_cmt__Action__c", "editable": true, "dataType": "PICKLIST", "alternateValues": null, "actions": { } }, "vlocity_cmt__AssetReferenceId__c": { "value": "e7423d01-2533-a274-106f-c977a9e30e98", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Asset Reference Id", "hidden": true, "fieldName": "vlocity_cmt__AssetReferenceId__c", "editable": true, "dataType": "STRING", "alternateValues": null, "actions": { } }, "vlocity_cmt__BillingAccountId__c": { "value": "0014T00000EIFwBQAX", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Billing Account", "hidden": false, "fieldName": "vlocity_cmt__BillingAccountId__c", "editable": true, "dataType": "REFERENCE", "alternateValues": null, "actions": { "availablesites": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/sites?cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&lookupField=vlocity_cmt__billingaccountid__c" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } } } }, "vlocity_cmt__CatalogItemReferenceDateTime__c": { "value": "2020-12-01T08:00:00.000Z", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Reference Time", "hidden": false, "fieldName": "vlocity_cmt__CatalogItemReferenceDateTime__c", "editable": true, "dataType": "DATETIME", "alternateValues": null, "actions": { } }, "vlocity_cmt__CurrencyPaymentMode__c": { "value": "Currency", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Currency Payment Mode", "hidden": true, "fieldName": "vlocity_cmt__CurrencyPaymentMode__c", "editable": true, "dataType": "PICKLIST", "alternateValues": null, "actions": { } }, "vlocity_cmt__EffectiveOneTimeTotal__c": { "value": 0.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "Effective One Time Total", "hidden": false, "fieldName": "vlocity_cmt__EffectiveOneTimeTotal__c", "editable": true, "dataType": "CURRENCY", "alternateValues": null, "actions": { } }, "vlocity_cmt__EffectiveRecurringTotal__c": { "value": 0.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "Effective Recurring Total", "hidden": false, "fieldName": "vlocity_cmt__EffectiveRecurringTotal__c", "editable": true, "dataType": "CURRENCY", "alternateValues": null, "actions": { } }, "vlocity_cmt__IsChangesAllowed__c": { "value": true, "previousValue": null, "originalValue": null, "messages": [ ], "label": "Changes Allowed", "hidden": false, "fieldName": "vlocity_cmt__IsChangesAllowed__c", "editable": true, "dataType": "BOOLEAN", "alternateValues": null, "actions": { } }, "vlocity_cmt__LineNumber__c": { "value": "0001.0003", "previousValue": null, "originalValue": null, "messages": [ ], "label": "LineNumber", "hidden": true, "fieldName": "vlocity_cmt__LineNumber__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": { } }, "vlocity_cmt__OneTimeCalculatedPrice__c": { "value": 10.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "One Time Calculated Price", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCalculatedPrice__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": { "adjustmentcodes": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&fields=vlocity_cmt__OneTimeCalculatedPrice__c&PricingVariableCode=OT_STD_PRC_CALC" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } }, "applyadjustment": { "rest": { "params": { "adjustments": [ { "PricingVariableCode": "OT_STD_PRC_CALC", "AdjustmentCode": "", "AdjustmentValue": 0, "AdjustmentMethod": "Percent", "DetailType": "ADJUSTMENT", "Field": "vlocity_cmt__OneTimeCalculatedPrice__c" } ], "id": "8024T000000hVrcQAE", "cartId": "8014T000000rXVoQAM" }, "method": "POST", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVrcQAE/pricing" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } }, "pricedetail": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVrcQAE/pricing?cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&fields=vlocity_cmt__OneTimeCalculatedPrice__c" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } } } }, "vlocity_cmt__OneTimeCharge__c": { "value": 10.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "One Time Charge", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": { "adjustmentcodes": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&fields=vlocity_cmt__OneTimeCharge__c&PricingVariableCode=OT_STD_PRC" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } }, "applyadjustment": { "rest": { "params": { "adjustments": [ { "PricingVariableCode": "OT_STD_PRC", "AdjustmentCode": "", "AdjustmentValue": 0, "AdjustmentMethod": "Percent", "DetailType": "ADJUSTMENT", "Field": "vlocity_cmt__OneTimeCharge__c" } ], "id": "8024T000000hVrcQAE", "cartId": "8014T000000rXVoQAM" }, "method": "POST", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVrcQAE/pricing" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } }, "pricedetail": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVrcQAE/pricing?cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&fields=vlocity_cmt__OneTimeCharge__c" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } } } }, "vlocity_cmt__OneTimeManualDiscount__c": { "value": 0.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "One Time Manual Discount", "hidden": false, "fieldName": "vlocity_cmt__OneTimeManualDiscount__c", "editable": true, "dataType": "PERCENT", "alternateValues": null, "actions": { } }, "vlocity_cmt__OneTimeTotal__c": { "value": 10.00, "previousValue": null, "originalValue": null, "messages": [ ], "label": "One Time Total", "hidden": false, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "alternateValues": null, "actions": { "adjustmentcodes": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/listsofvalues?listkeys=AdjustmentCodes&cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&fields=vlocity_cmt__OneTimeTotal__c&PricingVariableCode=OT_STD_PRC_TOTAL" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } }, "pricedetail": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/items/8024T000000hVrcQAE/pricing?cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&fields=vlocity_cmt__OneTimeTotal__c" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } } } }, "vlocity_cmt__ParentItemId__c": { "value": "c8539d4a-f9a8-4e52-11e7-bfd918f2b883", "previousValue": null, "originalValue": null, "messages": [ ], "label": "ParentItemId", "hidden": true, "fieldName": "vlocity_cmt__ParentItemId__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": { } }, "vlocity_cmt__Product2Id__c": { "value": "01t4T000000WTkBQAW", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Product", "hidden": false, "fieldName": "vlocity_cmt__Product2Id__c", "editable": true, "dataType": "REFERENCE", "alternateValues": null, "actions": { "availablesites": { "rest": { "params": { }, "method": "GET", "link": "/services/apexrest/daily_new/v2/cpq/carts/8014T000000rXVoQAM/sites?cartId=8014T000000rXVoQAM&id=8024T000000hVrcQAE&lookupField=vlocity_cmt__product2id__c" }, "remote": { "params": { } }, "client": { "records": [ ], "params": { } } } } }, "vlocity_cmt__ProductGroupKey__c": { "value": "eb006d2e-e816-7a0e-4060-2bed6511be52", "previousValue": null, "originalValue": null, "messages": [ ], "label": "Product Group Key", "hidden": false, "fieldName": "vlocity_cmt__ProductGroupKey__c", "editable": false, "dataType": "STRING", "alternateValues": null, "actions": { } }, "vlocity_cmt__ProductHierarchyGroupKeyPath__c": { "value": "40a771b8-f4f4-5e12-81ec-47b822007a7c", "vlocity_cmt__StringId__c":"a3c1N0000016TkfQAE", "vlocity_cmt__Translation__c":"spe<26>", "vlocity_cmt__LocaleCode__c":"fr", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkfQAE" }, "Id":"a3c1N0000016TkfQAE", "vlocity_cmt__BaseString__c":"SPE-26" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpTQAQ", "Name":"a3b1N000000pfpT", "vlocity_cmt__StringId__c":"a3c1N0000016TkfQAE", "vlocity_cmt__LocaleCode__c":"de", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkfQAE" }, "Id":"a3c1N0000016TkfQAE", "vlocity_cmt__BaseString__c":"SPE-26" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpUQAQ", "Name":"a3b1N000000pfpU", "vlocity_cmt__StringId__c":"a3c1N0000016TkgQAE", "vlocity_cmt__LocaleCode__c":"fi", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkgQAE" }, "Id":"a3c1N0000016TkgQAE", "vlocity_cmt__BaseString__c":"Demo1" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpVQAQ", "Name":"a3b1N000000pfpV", "vlocity_cmt__StringId__c":"a3c1N0000016TkgQAE", "vlocity_cmt__LocaleCode__c":"fr", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkgQAE" }, "Id":"a3c1N0000016TkgQAE", "vlocity_cmt__BaseString__c":"Demo1" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpWQAQ", "Name":"a3b1N000000pfpW", "vlocity_cmt__StringId__c":"a3c1N0000016TkgQAE", "vlocity_cmt__LocaleCode__c":"de", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkgQAE" }, "Id":"a3c1N0000016TkgQAE", "vlocity_cmt__BaseString__c":"Demo1" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpXQAQ", "Name":"a3b1N000000pfpX", "vlocity_cmt__StringId__c":"a3c1N0000016TkhQAE", "vlocity_cmt__LocaleCode__c":"fi", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkhQAE" }, "Id":"a3c1N0000016TkhQAE", "vlocity_cmt__BaseString__c":"TestProd-3" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpYQAQ", "Name":"gtestprod-3_fr", "vlocity_cmt__StringId__c":"a3c1N0000016TkhQAE", "vlocity_cmt__Translation__c":"gtestprod-3_fr", "vlocity_cmt__LocaleCode__c":"fr", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkhQAE" }, "Id":"a3c1N0000016TkhQAE", "vlocity_cmt__BaseString__c":"TestProd-3" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpZQAQ", "Name":"TestProd-3_german", "vlocity_cmt__StringId__c":"a3c1N0000016TkhQAE", "vlocity_cmt__Translation__c":"TestProd-3_german", "vlocity_cmt__LocaleCode__c":"de", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkhQAE" }, "Id":"a3c1N0000016TkhQAE", "vlocity_cmt__BaseString__c":"TestProd-3" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpeQAA", "Name":"serasdfwe", "vlocity_cmt__StringId__c":"a3c1N0000016TkjQAE", "vlocity_cmt__Translation__c":"serasdfwe", "vlocity_cmt__LocaleCode__c":"fr", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkjQAE" }, "Id":"a3c1N0000016TkjQAE", "vlocity_cmt__BaseString__c":"May17SpecialChars <= this text will be cut out" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpkQAA", "Name":"TestProd-10_fr", "vlocity_cmt__StringId__c":"a3c1N0000016TklQAE", "vlocity_cmt__Translation__c":"TestProd-10_fr", "vlocity_cmt__LocaleCode__c":"fr", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TklQAE" }, "Id":"a3c1N0000016TklQAE", "vlocity_cmt__BaseString__c":"TestProd-10" } }, { "displaySequence":-1, "Id":"a3b1N000000pfplQAA", "Name":"testprod-10", "vlocity_cmt__StringId__c":"a3c1N0000016TklQAE", "vlocity_cmt__Translation__c":"testprod-10", "vlocity_cmt__LocaleCode__c":"de", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TklQAE" }, "Id":"a3c1N0000016TklQAE", "vlocity_cmt__BaseString__c":"TestProd-10" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpmQAA", "Name":"demo-A_fi", "vlocity_cmt__StringId__c":"a3c1N0000016TkmQAE", "vlocity_cmt__Translation__c":"demo-A_fi", "vlocity_cmt__LocaleCode__c":"fi", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkmQAE" }, "Id":"a3c1N0000016TkmQAE", "vlocity_cmt__BaseString__c":"Demo-A" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpnQAA", "Name":"échantillon-a", "vlocity_cmt__StringId__c":"a3c1N0000016TkmQAE", "vlocity_cmt__Translation__c":"échantillon-a", "vlocity_cmt__LocaleCode__c":"fr", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkmQAE" }, "Id":"a3c1N0000016TkmQAE", "vlocity_cmt__BaseString__c":"Demo-A" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpoQAA", "Name":"demo-A", "vlocity_cmt__StringId__c":"a3c1N0000016TkmQAE", "vlocity_cmt__Translation__c":"demo-A", "vlocity_cmt__LocaleCode__c":"de", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TkmQAE" }, "Id":"a3c1N0000016TkmQAE", "vlocity_cmt__BaseString__c":"Demo-A" } }, { "displaySequence":-1, "Id":"a3b1N000000pfprQAA", "Name":"TESTPROD-4", "vlocity_cmt__StringId__c":"a3c1N0000016TknQAE", "vlocity_cmt__Translation__c":"TESTPROD-4", "vlocity_cmt__LocaleCode__c":"de", "vlocity_cmt__StringId__r":{ "attributes":{ "type":"vlocity_cmt__String__c", "url":"/services/data/v43.0/sobjects/vlocity_cmt__String__c/a3c1N0000016TknQAE" }, "Id":"a3c1N0000016TknQAE", "vlocity_cmt__BaseString__c":"TestProd-4" } } ] } ``` Media type: `application/json`. Schema: `getStringTranslationResponse`. ### PUT Update string translations. `PUT /stringtranslations` Operation ID: `Update string translations`. Tags: StringTranslations. update string translations. #### Request body (required) #### Request Example Update String Translations. ```json [ { "Id":"a4D41000000TaQ2EAK", "h_cpq_promotion__Translation__c":"Apr10_frNew", "h_cpq_promotion__StringId__c":"a4E41000000TqXjEAK", "h_cpq_promotion__LocaleCode__c":"fr" } ] ``` Media type: `application/json`. Schema: `UpdateStringTranslationRequest`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Media type: `application/json`. Schema: `UpdateStringTranslationResponse`. ### POST Create string translations. `POST /stringtranslations` Operation ID: `Create string translations`. Tags: StringTranslations. create string translations. #### Request body (required) #### Request Example Create String Translations. ```json [ { "h_cpq_promotion__Translation__c":"Apr10_frNew", "h_cpq_promotion__StringId__c":"a4E41000000TqXjEAK", "h_cpq_promotion__LocaleCode__c":"fr" } ] ``` Media type: `application/json`. Schema: `CreateStringTranslationRequest`. #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Media type: `application/json`. Schema: `CreateStringTranslationResponse`. ### DELETE Remove string translations `DELETE /stringtranslations/id` Operation ID: `Delete string translations`. Tags: StringTranslations. Remove string translations. Rest Handler - APIStringTranslationsV2 Method Invoked - deleteStringTranslations #### Parameters * `id` (path, string, required) salesforce id _Example_ ``` a4D41000000TaQ2EAK ``` #### Responses * **200** OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Media type: `application/json`. Schema: `deleteStringTranslationsResponse`. ### GET Get dictionary `GET /stringtranslations/dictionary/domain/localeCode` Operation ID: `Get dictionary`. Tags: StringTranslations. Return dictionary of given domain and locale code. Rest Handler - APIDictionaryStringTranslationsV2 Method Invoked - getDictionary #### Parameters * `domain` (path, string, required) domain is CPQ. _Example_ ``` CPQ ``` * `localeCode` (path, string, required) localeCode. For example en\_US. _Example_ ``` fr ``` * `page` (query, number) dictionary is divided into multiple pages. _Example_ ``` 1 ``` * `pageSize` (query, number) pageSize is number of words return in a page. _Example_ ``` 16000 ``` #### Responses * **200** ### dictionary api with page=1 ```json { "totalSize":1, "records": [ { "displaySequence":-1, "localeCode":"fr", "domain":"CPQ", "totalSize":15, "dictionary": { "TestProd-7":"TestProd-7_fr", "TestProd-8":"TestProd-8_fr", "ruleset-2 failed.":"fr_ruleset-2-failed", "ruleset-1-failed":"fr_ruleset-1-failed", "TestProd-6-child-1":"apple-1", "TestProd-6-root":"apple", "failed products":"failed products fr", "TestProd-2":"atestprod-fr", "TestProd-20":"htestprod-20", "TestProd-1":"ztestprod-fr", "Demo-B":"demo-B_fr", "Demo-A":"échantillon-a", "TestProd-10":"TestProd-10_fr", "TestProd-3":"gtestprod-3_fr", "Acc-1":"hr_fr" } } ] } ``` Media type: `application/json`. Schema: `dictionaryResponse`. ## Schemas ### CreateOrderBody A representation to create a new order. Includes all fields of `CreateCartBody`. * `inputFields` (_array of object_, required) An array of objects each defining a field and input value. Fields must be valid field API names for the Salesforce Order object [as defined here](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_order.htm) or Vlocity field extensions or fields from related objects using relationship names such as Account.Name [see Understanding Relationship Names](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_understanding.htm) for more information. _Example_ ``` { "subaction": "createOrder", "inputFields": [ { "accountid": "0016A0000072D43" }, { "effectivedate": "2017-12-07" }, { "status": "Draft" }, { "Pricebook2Id": "01s6A000002Y7wz" }, { "vlocity_cmt__OriginatingChannel__c": "Retail" }, { "name": "New customer order" } ], "fields": "Id,OrderNumber,Name,EffectiveDate,Status,AccountId,Account.Name,vlocity_cmt__EffectiveOrderTotal__c,vlocity_cmt__EffectiveRecurringTotal__c,TotalAmount,vlocity_cmt__OriginatingChannel__c" } ``` ### CreateCartResult Created cart. * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `actions` (_array of object_, read-only) * `action` (_Action_) * `records` (_array of Cart_) ### CartResult * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `records` (_array of CartDetail_) ### UpdateCartBody A representation to update the cart. * `inputFields` (_array of object_, required) An array of objects each defining a field and input value. Fields must be valid field API names for the Salesforce Order object [as defined here](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_order.htm) or Vlocity field extensions or fields from related objects using relationship names such as Account.Name [see Understanding Relationship Names](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_understanding.htm) for more information. _Example_ ``` { "inputFields": [ { "Pricebook2Id": "01s6A000002Y7wz" } ], "fields": "Id,Name" } ``` ### CartAttributeDetail Get Cart Attribute Details. * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `records` (_array of attributeCategory_) ### ValidateCartBody Request body sent in for validate cart * `cartId` (_string_) Example: `8011N00000157LkQAI`. * `methodName` (_string_) Example: `runCartValidation`. * `price` (_boolean_) Example: `true`. * `validate` (_boolean_) Example: `true`. ### ValidateCartResponse Response for the validate cart * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `actions` (_array of object_, read-only) * `action` (_Action_) * `records` (_array of Cart_) ### PostPromoCartResponse Response for the add promot to cart. * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `actions` (_array of object_, read-only) * `action` (_Action_) * `records` (_array of Cart_) ### SiteResult A detailed representation of a given cart. Includes all fields of `JsonResult`. ### Asset the Asset List * `Name` (_JsonField_) * `SerialNumber` (_JsonField_) * `Quantity` (_JsonField_) * `Status` (_JsonField_) * `vlocity_cmt__ProvisioningStatus__c` (_JsonField_) * `vlocity_cmt__RecurringTotal__c` (_JsonField_) * `vlocity_cmt__OneTimeTotal__c` (_JsonField_) * `childAssets` (_result_) ### PriceList * `Id` (_string_) Example: `a2Lf4000000TvFmEAK`. ### result * `totalSize` (_integer_, required) * `actions` (_array of object_) * `prev` (_Action_) * `next` (_Action_) * `messages` (_Error_, required) * `records` (_array of Account_, required) ### PriceCartBody Request body sent in for price cart * `cartId` (_string_) Example: `8011N00000157LkQAI`. * `methodName` (_string_) Example: `priceCart`. * `validate` (_boolean_) Example: `true`. * `limitScopeToPassedItem` (_boolean_) Example: `true`. * `items` (_array of any_) _Example_ ``` [ "80279000000Y5C9AAK", "80279000000Y5CAAA0" ] ``` ### Item The item in the delete * `messages` (_Messages_) * `Id` (_string_) Example: `80241000000Ha4aAAC`. ### ReplacementBody * `attributeCodesToCopyDuringReplace` (_array of any_) Determines which attributes to copy when replacing an offer. Specify the unique code of the attribute. _Example_ ``` [ "CMT-9413-4", "CMT-9413" ] ``` * `price` (_boolean_) Example: `true`. * `targetOfferIdToItemIds` (_string_) PriceBookEntryId of Target to RootLineItemId of Source Example: `01uf40000039ps9AAA:802f400000Pxl2mAAB`. ### TransformationBody * `attributeCodesToCopyDuringReplace` (_array of any_) Determines which attributes to copy when replacing an offer. Specify the unique code of the attribute. _Example_ ``` [ "CMT-9413-4", "CMT-9413" ] ``` * `price` (_boolean_) Example: `true`. * `replaceIntentSpecification` (_object_) * `SourceIntent` (_array of SourceIntentItem_) * `TargetIntent` (_object_) * `1` (_string_) Example: `01u1N00000FHXs0QAH`. ### getStringTranslationResponse get string translation response. * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `actions` (_array of object_, read-only) * `action` (_Action_) * `records` (_array of stringTranslationObject_) ### UpdateStringTranslationRequest Array of `stringTranslationObject`. ### UpdateStringTranslationResponse * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) ### CreateStringTranslationRequest Array of `stringTranslationObject`. ### CreateStringTranslationResponse * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) ### deleteStringTranslationsResponse * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) ### dictionaryResponse The response when an item is deleted from cart * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `records` (_array of dictionary_) ### CreateCartBody Discriminator: `subaction` selects the concrete type. * `subaction` (_string_, required) Type of cart to create and method to use to create it. Allowed values: `createOrder`, `createQuote`, `createOppty`, `assetToQuote`, `assetToOrder`, `assetChangeSite`. * `fields` (_string_) List of fields to return in the response, separated by commas. ### Messages Array of `object`. * `severity` (_string_) * `messageId` (_string_) * `code` (_integer (int32)_, required) * `message` (_string_, required) Example: `Successfully completed`. ### Action * `remote` (_object_, read-only) JavaScript Remoting URL * `REST` (_object_, read-only) REST URL ### Cart * `messages` (_Messages_) * `displaySequence` (_integer_) Sequence to display in the UI. Example: `-1`. * `Id` (_string_) Example: `8016A000000bwElQAI`. * `Name` (_string_) Example: `New customer order`. * `EffectiveDate` (_string (date)_) Example: `2017-12-25`. * `AccountId` (_string_) Example: `0016A0000053kHN`. * `Account.Name` (_string_) Example: `Acme Inc.`. * `EffectiveRecurringTotal__c` (_number (float)_) * `EffectiveOneTimeTotal__c` (_number (float)_) * `EffectiveOrderTotal__c` (_number (float)_) * `OrderNumber` (_string_) Order Number assigned by Salesforce Example: `00000141`. * `Status` (_string_) Example: `Draft`. ### CartDetail * `messages` (_Messages_) * `displaySequence` (_integer_) Sequence to display in the UI. Example: `-1`. * `details` (_object_) Cart details. Includes all fields of `JsonResult`. * `records` (_array of object_) * `Id` (_string_) Example: `8016A000000bwElQAI`. * `Name` (_string_) Example: `New customer order`. * `EffectiveDate` (_string (date)_) Example: `2017-12-25`. * `AccountId` (_string_) Example: `0016A0000053kHN`. * `Account.Name` (_string_) Example: `Acme Inc.`. * `EffectiveRecurringTotal__c` (_number (float)_) * `EffectiveOneTimeTotal__c` (_number (float)_) * `EffectiveOrderTotal__c` (_number (float)_) * `OrderNumber` (_string_) Order Number assigned by Salesforce Example: `00000141`. * `Status` (_string_) Example: `Draft`. * `orderStatusValue` (_string_) Example: `In Progress`. * `OrderStatus__c` (_string_) Example: `In Progress`. * `IsChangesAllowed__c` (_boolean_) Example: `true`. * `SupersededOrderId__c` (_string_) * `ObjectType` (_string_) Example: `Order`. * `discountsForSubmission` (_boolean_) Example: `false`. * `cartAddedDiscounts` (_number_) Example: `0`. * `canCheckoutDiscounts` (_boolean_) Example: `false`. * `isNotActiveContractDiscountPresent` (_boolean_) Example: `false`. * `accountDiscountsCount` (_number_) Example: `0`. * `contractDiscountsCount` (_number_) Example: `0`. * `frameAgreementPresent` (_boolean_) Example: `false`. * `isCartActivated` (_boolean_) Example: `true`. ### attributeCategory * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `Name` (_string_) Example: `Category1.0`. * `Id` (_string_) Example: `a0936000002rQiFAAU`. * `Code` (_string_) Example: `Al_size`. * `productAttributes` (_array of productAttribute_) ### JsonResult * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `records` (_array of object_) * `messages` (_Messages_) * `displaySequence` (_integer_) Sequence to display in the UI. Example: `-1`. * `actions` (_array of object_, read-only) ### JsonField * `datatype` (_string_) * `fieldName` (_string_) * `value` (_string_) * `editable` (_boolean_) * `hidden` (_boolean_) ### Error * `severity` (_string_) Severity of the error. Typically "ERROR" * `messageId` (_string_) * `code` (_integer (int32)_, required) * `message` (_string_, required) Example: `Error Message`. ### Account * `Name` (_string_) * `PhotoUrl` (_string_) * `OwnerId` (_string_) ### SourceIntentItem * `GroupId` (_integer_, required) specifies which group this item would be part of in the target Example: `1`. * `ActionParameter` (_string_, required) specifies the replacement price book entry of the replacement item. Only valid when the Action is set to Replace Example: `01u1N00000GNlFFQA1`. * `Action` (_string_, required) specifies the source action (Disconnect, Keep, or Replace) Example: `Replace`. * `LineItemId` (_string_, required) the line item id to which the action will be applied. Example: `0QL1N000002UiEVWA0`. ### stringTranslationObject string translations * `displaySequence` (_integer_) Sequence to display in the UI. Example: `-1`. * `Id` (_string_) Example: `a3b1N000000pfpLQAQ`. * `Name` (_string_) Example: `Root 1`. * `vlocity_cmt__StringId__c` (_string_) Example: `a3c1N0000016TkaQAE`. * `vlocity_cmt__Translation__c` (_string_) Example: `hello_fr`. * `vlocity_cmt__LocaleCode__c` (_string_) Example: `fr`. * `vlocity_cmt__StringId__r` (_stringObject_) ### dictionary The response for dictionary * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `domain` (_string_) domain is CPQ. Example: `CPQ,`. * `localeCode` (_string_) locale code. Example: `fr`. * `dictionary` (_object_) mapping of words/sentences. Additional properties: `object`. * `code` (_string_) * `text` (_string_) ### productAttribute Product Attribute * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `Name` (_string_) Example: `Attribute1.0`. * `attributeId` (_string_) Example: `a0A36000007YtQIEA0`. * `label` (_string_) Example: `Description`. * `values` (_array of attributeValue_) ### stringObject represent string object * `Id` (_string_) Example: `a3b1N000000pfpLQAQ`. * `vlocity_cmt__BaseString__c` (_string_) Example: `hello`. ### attributeValue Attribute Value * `id` (_string_) Example: `1`. * `name` (_string_) Example: `1`. * `label` (_string_) Example: `label1`. ### CartPromotions Includes all fields of `JsonResult`. * `records` (_array of CartPromotion_) ### AccountAppliedPromotions Includes all fields of `JsonResult`. * `records` (_array of AppliedPromotion_) ### CartPromotion Representation of an available or applied promotion. * `displaySequence` (_integer_, read-only) Sequence to display in the UI. Example: `0`. * `Name` (_string_, read-only) (Available promotions only) Name of the promotion. Example: `Summer TV Blowout`. * `vlocity_cmt__Code__c` (_string_, read-only) (Available promotions only) Code the identifies the given promotion. Example: `DEC123`. * `vlocity_cmt__Description__c` (_string_, read-only) (Available promotions only) Description of the promotion. Example: `25% Off HD Promo`. * `Id` (_string_, read-only) (Available promotions only) Id of the promotion (Salesforce Id). Example: `a2B37000000u5PEEAY`. * `category` (_string_, read-only) Qualification Category - Whether the promotion is _qualified_ or _disqualified_ for this cart. Allowed values: `qualified`, `disqualified`. Example: `qualified`. * `qualifications` (_array of Qualification_, read-only) * `vlocity_cmt__Sequence__c` (_object_) (Applied promotions only) Sequence in which this promotion is applied to the cart. Includes all fields of `JsonField`. * `vlocity_cmt__PromotionId__r` (_object_) (Applied promotions only) Id of the promotion. Includes all fields of `LinkField`. * `vlocity_cmt__CommitmentStartDate__c` (_object_) (Applied promotions only) Includes all fields of `JsonField`. * `vlocity_cmt__CommitmentEndDate__c` (_object_) (Applied promotions only) Includes all fields of `JsonField`. * `vlocity_cmt__PricingStartDate__c` (_object_) (Applied promotions only) Includes all fields of `JsonField`. * `vlocity_cmt__PricingEndDate__c` (_object_) (Applied promotions only) Includes all fields of `JsonField`. * `vlocity_cmt__RequestDate__c` (_object_) (Applied promotions only) Includes all fields of `JsonField`. * `vlocity_cmt__AppliesTo__c` (_object_) (Applied promotions only) Includes all fields of `JsonField`. ### AppliedPromotion Representation of an applied promotion which is applied to an account, contract or asset(s). * `vlocity_cmt__Sequence__c` (_JsonField_) * `vlocity_cmt__PromotionId__r` (_LinkField_) * `vlocity_cmt__PromotionDescription` (_JsonField_) * `vlocity_cmt__CommitmentStartDate__c` (_JsonField_) * `vlocity_cmt__CommitmentEndDate__c` (_JsonField_) * `vlocity_cmt__PricingStartDate__c` (_JsonField_) * `vlocity_cmt__PricingEndDate__c` (_JsonField_) * `vlocity_cmt__CancellationDate__c` (_JsonField_) * `vlocity_cmt__AppliedDate__c` (_JsonField_) * `vlocity_cmt__AppliesTo__c` (_JsonField_) * `category` (_string_, read-only) Qualification Category - Whether the applied promotion is now _qualified_ or _disqualified_ for the current state of the customer account. Allowed values: `qualified`, `disqualified`. Example: `qualified`. * `qualifications` (_array of Qualification_, read-only) ### Qualification Representation of a qualification required for the object it describes and whether it passes or fails for that object. * `type` (_string_) Type of qualification such as rule set, rule or rule condition. Allowed values: `RuleSet`, `Rule`, `RuleCondition`. * `name` (_string_) Name of the qualification. * `qualifies` (_boolean_) Whether this qualification is satisfied or not. * `failureMessage` (_string_) If not satisfied, a message explaining why not. * `qualifications` (_array of Qualification_) ### AccountDisqualifiedPromotions Includes all fields of `JsonResult`. * `records` (_array of AppliedPromotion_) ### LineItem The Line Item object * `itemId` (_JsonField_) * `Id` (_JsonField_) * `Pricebook2Id__r` (_LinkField_) * `Product2Id__r` (_LinkField_) * `ProductCode` (_JsonField_) * `vlocity_cmt__EffectiveQuantity__c` (_JsonField_) * `vlocity_cmt__OneTimeTotal__c` (_JsonField_) * `vlocity_cmt__RecurringCharge__c` (_JsonField_) * `attributeCategory` (_attributeCategory_) ### CreateQuoteBody A representation to create a new quote. Includes all fields of `CreateCartBody`. * `inputFields` (_array of object_, required) An array of objects each defining a field and input value. Fields must be valid field API names for the Salesforce Quote object [as defined here](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_quote.htm) or Vlocity field extensions or fields from related objects using relationship names such as Account.Name [see Understanding Relationship Names](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_understanding.htm) for more information. _Example_ ``` { "subaction": "createQuote", "inputFields": [ { "accountId": "0016A0000072D43" }, { "opportunityId": "0066A000002aVklQAE" }, { "status": "Draft" }, { "Pricebook2Id": "01s6A000002Y7wz" }, { "vlocity_cmt__OriginatingChannel__c": "Retail" }, { "name": "New customer quote" } ], "fields": "Id,QuoteNumber,Name,OpportunityId,Status,AccountId,Account.Name,vlocity_cmt__EffectiveQuoteTotal__c,vlocity_cmt__EffectiveRecurringTotal__c,GrandTotal,vlocity_cmt__OriginatingChannel__c" } ``` ### CreateOpptyBody A representation to create a new opportunity. Includes all fields of `CreateCartBody`. * `inputFields` (_array of object_, required) An array of objects each defining a field and input value. Fields must be valid field API names for the Salesforce Opportunity object [as defined here](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunity.htm) or Vlocity field extensions or fields from related objects using relationship names such as Account.Name [see Understanding Relationship Names](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_understanding.htm) for more information. _Example_ ``` { "subaction": "createOppty", "inputFields": [ { "accountId": "0016A0000053kHN" }, { "stageName": "Prospecting" }, { "name": "New customer opportunity" }, { "type": "New Customer" }, { "closeDate": "2017-12-07" }, { "vlocity_cmt__NumberOfContractedMonths__c": 24 }, { "Pricebook2Id": "01s6A000002Y7wz" }, { "vlocity_cmt__OriginatingChannel__c": "Dealer" } ], "fields": "Id,Name,AccountId,Account.Name,vlocity_cmt__EffectiveRecurringTotal__c,vlocity_cmt__EffectiveOneTimeTotal__c,vlocity_cmt__EffectiveOpportunityTotal__c,Amount,vlocity_cmt__OriginatingChannel__c" } ``` ### AssetToOrderBody A representation to create a new order from an array of customer assets. Includes all fields of `CreateCartBody`. * `inputFields` (_array of object_, required) An array of objects each defining a field and input value. Fields must be valid field API names for the Salesforce Order object [as defined here](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_order.htm) or Vlocity field extensions or fields from related objects using relationship names such as Account.Name [see Understanding Relationship Names](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_understanding.htm) for more information. _Example_ ``` { "subaction": "assetToOrder", "accountId": "0016A0000072D3y", "requestDate": "2017-12-07", "assetIdList": [ "01t36000000pfcKAAQ", "02i6A000000YEXN" ], "fields": "Id,OrderNumber,Name,EffectiveDate,Status,AccountId,Account.Name,vlocity_cmt__EffectiveOrderTotal__c,vlocity_cmt__EffectiveRecurringTotal__c,TotalAmount,vlocity_cmt__OriginatingChannel__c" } ``` ### AddCartItemBody A representation to update the cart. * `inputFields` (_array of object_, required) An array of objects each defining a field and input value. Fields must be valid field API names for the Salesforce Order object [as defined here](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_order.htm) or Vlocity field extensions or fields from related objects using relationship names such as Account.Name [see Understanding Relationship Names](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_understanding.htm) for more information. _Example_ ``` { "items": [ { "itemId": "01uf4000000gmRTAAY", "parentId": "802f4000000PZ1VAAW", "parentRecord": { "records": [ { "messages": [], "displaySequence": -1, "Id": { "messages": [], "label": "Order Product ID", "hidden": false, "fieldName": "Id", "editable": false, "dataType": "ID", "value": "802f4000000PZ1VAAW" }, "UnitPrice": { "messages": [], "label": "Unit Price", "hidden": true, "fieldName": "UnitPrice", "editable": false, "dataType": "CURRENCY", "value": 358.95 }, "productId": "01tf4000000Kd0uAAC", "defaultQuantity": 1, "minQuantity": 0, "maxQuantity": 99999, "groupMinQuantity": 0, "groupMaxQuantity": 99999, "sequenceNumber": 1, "productHierarchyPath": "01tf4000000Kd0uAAC", "itemType": "lineItem", "childProducts": { "records": [ { "Name": { "label": "Product Name", "value": "PRODUCT-77151" }, "UnitPrice": { "label": "List Price", "value": 0 }, "vlocity_cmt__RecurringPrice__c": { "label": "Recurring Price", "value": 0 }, "Product2Id": { "label": "Product ID", "value": "01tf4000000Kd0zAAC" }, "Pricebook2Id": { "label": "Price Book ID", "value": "01sf4000003LYn3AAG" }, "Id": { "label": "Price Book Entry ID", "value": "01uf4000000gmRTAAY" }, "defaultQuantity": 0, "productId": "01tf4000000Kd0zAAC", "Product2": { "Name": "PRODUCT-77151", "RecordTypeId": "012f40000004zEOAAY", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__SubType__c": "None", "vlocity_cmt__Type__c": "None" }, "messages": [], "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [ { "parentId": "802f4000000PZ1VAAW", "quantity": 0, "itemId": "01uf4000000gmRTAAY" } ], "cartId": "801f4000000ChZjAAK" }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/801f4000000ChZjAAK/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [ { "parentId": "802f4000000PZ1VAAW", "quantity": 0, "itemId": "01uf4000000gmRTAAY" } ], "cartId": "801f4000000ChZjAAK", "methodName": "postCartsItems" } }, "client": { "params": { "pagesize": 0, "hierarchy": 0 } } } } } ] }, "vlocity_cmt__RecurringPrice__c": 527.96, "name": "PRODUCT-39982", "provisioningStatus": "New", "Product2Id": "01tf4000000Kd0uAAC", "PricebookEntryId": { "messages": [], "label": "Price Book Entry ID", "hidden": false, "fieldName": "PricebookEntryId", "editable": false, "dataType": "REFERENCE", "value": "01uf4000000gmRJAAY" }, "Quantity": { "messages": [], "label": "Quantity", "hidden": false, "fieldName": "Quantity", "editable": true, "dataType": "DOUBLE", "value": 1 }, "vlocity_cmt__OneTimeTotal__c": { "messages": [], "label": "One Time Total", "hidden": false, "fieldName": "vlocity_cmt__OneTimeTotal__c", "editable": false, "dataType": "CURRENCY", "value": 358.95 }, "vlocity_cmt__RecurringTotal__c": { "messages": [], "label": "Recurring Total", "hidden": false, "fieldName": "vlocity_cmt__RecurringTotal__c", "editable": false, "dataType": "CURRENCY", "value": 527.96 }, "vlocity_cmt__OneTimeCharge__c": { "messages": [], "label": "One Time Charge", "hidden": true, "fieldName": "vlocity_cmt__OneTimeCharge__c", "editable": false, "dataType": "CURRENCY", "value": 358.95 }, "vlocity_cmt__RecurringCharge__c": { "messages": [], "label": "Recurring Charge", "hidden": true, "fieldName": "vlocity_cmt__RecurringCharge__c", "editable": false, "dataType": "CURRENCY", "value": 527.96 }, "vlocity_cmt__RecurringManualDiscount__c": { "messages": [], "label": "Recurring Manual Discount", "hidden": false, "fieldName": "vlocity_cmt__RecurringManualDiscount__c", "editable": true, "dataType": "PERCENT", "value": 0 }, "vlocity_cmt__OneTimeManualDiscount__c": { "messages": [], "label": "One Time Manual Discount", "hidden": false, "fieldName": "vlocity_cmt__OneTimeManualDiscount__c", "editable": true, "dataType": "PERCENT", "value": 0 }, "PricebookEntry": { "Product2Id": "01tf4000000Kd0uAAC", "Pricebook2Id": "01sf4000003LYn3AAG", "Id": "01uf4000000gmRJAAY", "Product2": { "Name": "PRODUCT-39982", "Id": "01tf4000000Kd0uAAC", "vlocity_cmt__Type__c": "None", "vlocity_cmt__IsConfigurable__c": "false" } }, "Product2": { "Name": "PRODUCT-39982", "RecordTypeId": "012f40000004zEOAAY", "vlocity_cmt__IsConfigurable__c": false, "vlocity_cmt__SubType__c": "None", "vlocity_cmt__Type__c": "None" }, "vlocity_cmt__ItemName__c": { "messages": [], "label": "Item Name", "hidden": false, "fieldName": "vlocity_cmt__ItemName__c", "editable": true, "dataType": "STRING" }, "actions": { "addtocart": { "rest": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [ { "parentId": "802f4000000PZ1VAAW", "quantity": 1, "itemId": "01uf4000000gmRJAAY" } ], "cartId": "801f4000000ChZjAAK" }, "method": "POST", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/801f4000000ChZjAAK/items" }, "remote": { "params": { "price": true, "validate": true, "includeAttachment": false, "pagesize": 20, "hierarchy": -1, "items": [ { "parentId": "802f4000000PZ1VAAW", "quantity": 1, "itemId": "01uf4000000gmRJAAY" } ], "cartId": "801f4000000ChZjAAK", "methodName": "postCartsItems" } }, "client": { "params": { "pagesize": 0, "hierarchy": 0 } } } } } ] } } ], "hierarchy": "0,", "pagesize": "0,", "levelBasedApproach": false } ``` ### NewAccountSite Request body sent to create new account for the current site. * `cartId` (_string_) Example: `8011N00000157LkQAI`. * `methodName` (_string_) Example: `newSite`. * `ObjectType` (_string_) Example: `Account`. * `items` (_array of any_) _Example_ ``` [ "Name", "vlocity_cmt__Active__c" ] ``` ### DeleteCartItem The response when an item is deleted from cart * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `actions` (_array of object_, read-only) * `action` (_Action_) * `records` (_array of Item_) ### PostPricingResponse Response for the post pricing of lineItems. * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `actions` (_array of object_, read-only) * `action` (_Action_) ### GetCartItemResult Response of Get Cart Items * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `records` (_array of CartItem_) ### CartItem Response of Get Cart Items * `messages` (_Messages_) * `actions` (_Action_) * `itemId` (_string_) itemId Example: `01u41000001QPtsAAG`. ### GetProductResult The list of products in the selectables * `totalSize` (_integer_, read-only) Number of records in the records array. Example: `1`. * `messages` (_Messages_) * `actions` (_array of object_, read-only) * `action` (_Action_) * `records` (_array of Product_) ### Product the product object * `messages` (_Messages_) * `displaySequence` (_integer_) Sequence to display in the UI. Example: `-1`. * `Id` (_string_) Example: `01u41000001QPs0AAG`. * `Pricebook2Id` (_string_) Example: `01s41000005dPYQAA2`. * `Product2Id` (_string_) Example: `01t41000000sYZQAA2`. * `UnitPrice` (_number (float)_) Example: `1`. * `Name` (_string_) Example: `Root 1`. * `IsActive` (_boolean_) Example: `true`. ### LinkField * `Id` (_string_) * `Name` (_string_) * `Url` (_string_)