swagger: "2.0" info: description: > Vlocity 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.Version two of the CPQ APIs simplifies the APIs for mobile and external app development. The v2 APIs are the default APIs used by Vlocity applications. Base URL for the apis described is 'xx##.salesforce.com/services/apexrest/vlocity_cmt/v2'. Last updated: 12/18/2019 version: V 101 title: 'Vlocity Configure, Price, Quote Web APIs v2 Documentation' host: 'xx##.salesforce.com' schemes: - https basePath: /services/apexrest/vlocity_cmt/v2 parameters: accountId: name: accountid in: path required: true type: string description: Customer Account Id (Salesforce Id) - Required x-example: 001f4000007hynC cartId: name: cartid in: path required: true type: string description: 'Cart Id (Salesforce Id).Opportunity, Quote or Order Id. - Required' x-example: 801360000000oQ9 pricebookEntryId: name: pricebookEntryId in: path required: true type: string description: 'Price book entry Id (Salesforce Id).' x-example: 01u46000002U5LKAA0 fields: name: fields in: query required: false type: array items: type: string collectionFormat: csv description: 'List of fields to return in the response, separated by commas.' x-example: 'Id,Name' price: name: price in: query description: specifies the fields to be sorted required: false type: boolean x-example: true validate: name: validate in: query description: specifies the filter field values required: false type: boolean x-example: true itemId: name: itemId in: path description: Line Item Id under the cart- Required required: true type: string x-example: 80236000009E2InAAK productHierarchyPath: name: productHierarchyPath in: query description: Product hierarchy path of the item getting expanded type: string x-example: 01t36000004hM92AAE<01t36000004hM8xAAE pagesize: name: pagesize in: query description: Number of records to be returned required: false type: integer x-example: 10 filters: name: filters in: query description: Filter field values. required: false type: string x-example: 'vlocity_cmt__AppliesTo__c:Account_Contract' filter: name: filter in: query description: Filter field values. required: false type: string x-example: 'vlocity_cmt__ServiceAccountId__c:991360000008eNU_991360000008eNY' commitmentDateFilter: name: commitmentDateFilter in: query description: Filters active applied promotions based on this date required: false type: string x-example: 2017-04-05T07:00:00.000Z appliedPromoStatusFilter: name: appliedPromoStatusFilter in: query description: Filter to specific the kind of applied promotions to be retrieved. required: false type: string x-example: Active hierarchy: name: hierarchy in: query description: product hierarchy required: false type: integer x-example: 2 maxProdListHierarchy: name: maxProdListHierarchy in: query description: hierarchy depth returned for list of products required: false type: integer x-example: 5 lastRecordId: name: lastRecordId in: query description: 'The last record ID from the previous search result, if available' required: false type: string x-example: 01uf4000001q1W3AAI includeAttachment: name: includeAttachment in: query description: Whether product attachments are returned required: false type: boolean x-example: true includeIneligible: name: includeIneligible in: query description: Whether to include ineligible products or not required: false type: boolean x-example: true category: name: category in: query description: Category to which the product belongs required: false type: string x-example: 'Qualified, Disqualified' offsetSize: name: offsetSize in: query description: 'Offset from which to start reading products, for pagination.' required: false type: integer x-example: 2 expandAll: name: expandAll in: query type: boolean required: false description: level of hierarchy for assets x-example: false sortBy: name: sortBy in: query description: Used to sort based on field(s) required: false type: string x-example: Name_DESC searchBy: name: searchBy in: query description: Used to search required: false type: string x-example: 'searchBy:hello' id: name: id in: query description: Used to get details for given salesforce id required: false type: string x-example: a3b1N000000poiTQAQ ContextId: name: ContextId in: query description: same as cart id required: false type: string x-example: 801360000000oQ9 objectTypeToIdsToClone: name: objectTypeToIdsToClone in: query description: specifies the type and ids of records to clone. required: false type: string x-example: OrderItem:8021N000008NG5t_8021N000008NG5s validateSubmittedXLI: name: validateSubmittedXLI in: query description: flag to decide whether to run the pre submit validation or not. required: false type: boolean x-example: false checkOrderStatus: name: checkOrderStatus in: query description: flag to decide whether to verify the order status prior to check out or not. required: false type: boolean x-example: true provisioningStatus: name: provisioningStatus in: query description: determines the provisioning status to use for newly created assets. required: false type: string x-example: Active effectiveAssetsDateFilter: name: effectiveAssetsDateFilter in: query description: Filters assets based on this date required: false type: string x-example: 2017-04-05T07:00:00.000Z assetId: name: assetId in: path description: asset id required: true type: string x-example: 02i46000000SyRk paths: /carts: post: tags: - Cart summary: Create Cart description: > Creates an opportunity, order, or quote based on the subaction specified in the request body. Subaction also defines method of creation. 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. **Please note these subactions cover the Create Cart and the Change Asset to Order APIs in the Developer Documentation.** ** Rest Handler - CpqCreateCartActionV2. Method Invoked - postCartItems.** operationId: CpqCreateCartActionV2-POST produces: - application/json consumes: - application/json parameters: - name: requestBody in: body description: > Different request bodies must be used for each of the different subactions - Required. ### 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. required: true schema: $ref: '#/definitions/CreateOrderBody' - $ref: '#/parameters/cartId' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/CreateCartResult' '400': description: Bad Request - Invalid subaction or Invalid Parameters '/cpq/carts/{cartid}': parameters: - $ref: '#/parameters/cartId' get: tags: - Cart summary: Get Cart Summary description: > 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 operationId: APICartsCpqV2-GET produces: - application/json parameters: - $ref: '#/parameters/validate' - $ref: '#/parameters/price' - name: headerFieldSet in: query description: > 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. required: false type: string x-example: fieldSetFeature - name: translation in: query description: 'to get translated labels, default is true (CMT 101)' required: false type: boolean x-example: true responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/CartResult' put: tags: - Cart summary: Update Cart Summary description: >- Update the cart summary. Rest Handler - APICartsCpqV2. Method Invoked - updateCarts operationId: APICartsCpqV2-PUT consumes: - application/json produces: - application/json parameters: - name: requestBody in: body description: | Request Body with input fields - Required ### Update Cart Request Example ```json { "inputFields":[ { "Pricebook2Id":"01s6A000002Y7wz" }, ], "fields":"Id,Name" } ``` required: true schema: $ref: '#/definitions/UpdateCartBody' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. '/cpq/carts/{cartid}/attributes': get: tags: - Cart summary: Get Filterable Attributes description: >- 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 operationId: APICartsAttributesCpqV2-GET parameters: - $ref: '#/parameters/cartId' produces: - application/json responses: '200': description: Return the filterable attributes that are applicable for this cart schema: $ref: '#/definitions/CartAttributeDetail' '/cpq/carts/{cartid}/validate': post: tags: - Cart produces: - application/json consumes: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/price' - $ref: '#/parameters/validate' - name: requestBody in: body description: | Request Body with cartId - required ### Validate Cart Request Example ```json { "cartId":"8011N00000157LkQAI", "methodName":"runCartValidation", "price":true, "validate":true } ``` required: false schema: $ref: '#/definitions/ValidateCartBody' summary: Runs validation and pricing for the items in the cart. description: Runs validation and pricing for the items in the cart. operationId: validate-POST responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. Rest Handler - validate Method Invoked - runCartValidation schema: $ref: '#/definitions/ValidateCartResponse' '/cpq/carts/{cartid}/items': parameters: - $ref: '#/parameters/cartId' get: tags: - Cart summary: Get Cart Items description: >- Get a representation of the items in a specified cart. Rest Handler - APIItemsCartsCpqV2 Method Invoked - getCartsItems operationId: APIItemsCartsCpqV2-GET parameters: - name: query in: query description: Search text type: string x-example: iphone+6s - name: id in: query description: List of comma separated itemIds to return only the corresponding cart Items type: string x-example: 01u41000001QPtsAAG - $ref: '#/parameters/lastRecordId' - $ref: '#/parameters/pagesize' - $ref: '#/parameters/hierarchy' - $ref: '#/parameters/includeAttachment' - $ref: '#/parameters/fields' - $ref: '#/parameters/filter' - $ref: '#/parameters/price' - $ref: '#/parameters/validate' produces: - application/json responses: '200': description: | 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__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": {} } }] } ``` post: tags: - Cart summary: Add Item(s) to a Cart description: > Add one or more items to a specified cart. Rest Handler - APIItemsCartsCpqV2 Method Invoked - postCartsItems operationId: APIItemsCartsCpqV2-POST produces: - application/json parameters: - name: requestBody in: body description: | 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 } ``` schema: $ref: '#/definitions/ValidateCartResponse' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. put: tags: - Cart summary: Update Item(s) in a Cart description: > Update one or more items in a specified cart. Rest Handler - APIItemsCartsCpqV2 Method Invoked - putCartsItems operationId: APIItemsCartsCpqV2-POST UPDATE produces: - application/json parameters: - name: requestBody in: body description: | 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" } } } ] } } ``` schema: $ref: '#/definitions/ValidateCartResponse' responses: '200': description: >- 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 } ] } } ] } } ] } ``` delete: tags: - Cart summary: Remove Item(s) from a Cart description: > Remove one or more items from a specified cart. Rest Handler - APIItemsCartsCpqV2 Method Invoked - deleteCartsItems operationId: APIItemsCartsCpqV2-DELETE parameters: - $ref: '#/parameters/itemId' - $ref: '#/parameters/hierarchy' - $ref: '#/parameters/lastRecordId' - $ref: '#/parameters/pagesize' - $ref: '#/parameters/includeAttachment' - $ref: '#/parameters/fields' - name: query in: query description: Search text type: string x-example: iphone+6s produces: - application/json responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/DeleteCartItem' '/cpq/carts/{cartid}/promotions': parameters: - $ref: '#/parameters/cartId' get: tags: - Cart summary: Get Applied or Available Promotions for a Cart description: > 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 operationId: APIPromotionsCartsCpqV2-GET produces: - application/json parameters: - name: subaction in: query description: >- An optional subaction that switches what data is returned from the request. required: false type: string enum: - getPromotionsAppliedToCart - name: include in: query description: >- Optional components to include in the response. Currently only *qualifications*. required: false type: string enum: - qualifications - name: includePenalties in: query description: >- whether to return the penalties for the promotions in the result or not required: false type: boolean x-example: true - name: ruleType in: query description: >- Indicates which type of context rule to run. This should be used when we have includes param as qualifications or evaluation required: false type: string x-example: evaluation - name: ruleEvaluationInput in: query description: >- 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 required: false type: string x-example: Order: OriginatingChannel__c: Web - $ref: '#/parameters/filters' - $ref: '#/parameters/category' - $ref: '#/parameters/fields' - $ref: '#/parameters/pagesize' - $ref: '#/parameters/commitmentDateFilter' - $ref: '#/parameters/appliedPromoStatusFilter' responses: '200': description: | | 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: tags: - Cart summary: Add Promotion to a Cart description: > Add promotion to a specified cart. Rest Handler - APIPromotionsCartsCpqV2 Method Invoked - postCartsPromoItems operationId: APIPromotionsCartsCpqV2-POST produces: - application/json parameters: - name: requestBody in: body description: | Request Body with input fields ### Add Promotion to a Cart Request Example ```json { "items": [ { "itemId":"a30460000001vbgAAA" } ], "price": false, "validate": false, } ``` schema: $ref: '#/definitions/PostPromoCartResponse' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. delete: tags: - Cart description: >- This API delete applied promotions items from cart Rest Handler - APIPromotionsCartsCpqV2 Method Invoked - deletePromotionItems summary: Delete of Promotion Items in Cart. operationId: APIPromotionsCartsCpqV2 -DELETE produces: - application/json parameters: - name: id in: query description: Applied promotion item Id type: string x-example: a2Lf40000008nL5EAI - name: requestBody in: body description: | Request Body with input fields ### Delete Promotion Items in Cart Request Example ```json { "id": "a2Lf40000008nL5EAI", "cartId": "801f40000012NEIAA2", "methodName": "deleteAppliedPromoItems", "price": true, "validate": true } ``` schema: $ref: '#/definitions/ValidateCartResponse' responses: '200': description: | ### 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" }] } } } } } ``` '/accounts/{accountid}/promotions': parameters: - $ref: '#/parameters/accountId' get: tags: - Customer summary: Get Applied Promotions for a Customer Account description: > 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 operationId: APIAppliedPromotionsAccountsV2-GET produces: - application/json parameters: - name: includes in: query description: >- Optional components to include in the response. Currently only *qualifications*. required: false type: string enum: - qualifications - $ref: '#/parameters/filters' - $ref: '#/parameters/category' - $ref: '#/parameters/fields' - $ref: '#/parameters/pagesize' - $ref: '#/parameters/commitmentDateFilter' - $ref: '#/parameters/appliedPromoStatusFilter' - name: ruleType in: query description: >- Indicates which type of context rule to run. This should be used when we have includes param as qualifications or evaluation required: false type: string x-example: evaluation - name: ruleEvaluationInput in: query description: The input to be used in the evaluation of context rules required: false type: string x-example: Order: OriginatingChannel__c: Web responses: '200': description: | ### 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" }] } ``` '/cpq/carts/{cartid}/products': get: tags: - Cart summary: Get List of Products description: >- Get list of products available to be added to the cart based on the given criteria. Rest Handler - APIProductsCartsCpqV2 Method Invoked - getCartsProducts operationId: APIProductsCartsCpqV2-GET produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/maxProdListHierarchy' - $ref: '#/parameters/lastRecordId' - $ref: '#/parameters/includeAttachment' - $ref: '#/parameters/filters' - $ref: '#/parameters/offsetSize' - $ref: '#/parameters/fields' - $ref: '#/parameters/pagesize' - name: attributes in: query description: >- 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. type: string x-example: 'attr1:attr116gb_32gb,attr2:red' - name: includeAttributes in: query description: >- Specifies whether to return a list of attributes and their values for the product. type: boolean x-example: true - name: query in: query description: Search text type: string x-example: iphone+6s responses: '200': description: | ### 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" }] } ``` '/cpq/carts/{cartid}/products/{pricebookEntryId}': get: tags: - Cart summary: Get details of a product. description: >- 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 operationId: APIProductsCartsCpqV2-GET-getCartsProductsById produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/pricebookEntryId' - $ref: '#/parameters/maxProdListHierarchy' - $ref: '#/parameters/includeAttachment' - $ref: '#/parameters/filters' - $ref: '#/parameters/fields' - name: includeAttributes in: query description: >- Specifies whether to return a list of attributes and their values for the product. type: boolean x-example: true responses: '200': description: | ### 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" } ``` '/cpq/carts/{cartid}/products/compare': parameters: - $ref: '#/parameters/cartId' - name: id in: query description: Id of the product required: false type: string x-example: '01t36000000pfcKAAQ,01t36000000pfcKAAQ' get: tags: - Cart description: >- Get a list of products to be added to cart for comparison. Rest Handler - APICompareProductsCartsCpqV2 summary: Get a list of products to be added to cart for comparison. operationId: APICompareProductsCartsCpqV2 - GET produces: - application/json responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. '/cpq/carts/{cartid}/sites': parameters: - $ref: '#/parameters/cartId' post: tags: - Cart description: Create a New Account. Remote Handler- APISitesCartsCpqV2 summary: Create a New Account for the Current Cart. operationId: APISitesCartsCpqV2-POST produces: - application/json parameters: - name: objectType in: query description: Object type to create required: true type: string x-example: Account - name: inputFields in: query required: false type: array items: type: string collectionFormat: csv description: List of fields to fill x-example: null - $ref: '#/parameters/fields' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/SiteResult' '400': description: Bad Request - Invalid Parameter get: tags: - Cart description: >- Gets the available records for the billing account or service account look up field. Remote Handler-APISitesCartsCpqV2 Method Invoked - getAvailableSites summary: Get Available Sites operationId: APISitesCartsCpqV2 - GET produces: - application/json parameters: - $ref: '#/parameters/fields' - name: lookupField in: query description: Field on the line item to look up required: true type: string x-example: vlocity_cmt__BillingAccountId__c - $ref: '#/parameters/itemId' responses: '200': description: | ### 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" } ] } ``` '/accounts/{accountId}/assets': get: description: >- Get a list of assets given acount Id and account type to be included.RestHandler- CpqAssetsContractsActionV2 Mehtod Invoked -getAssetsByAccount tags: - Customer summary: Get Asset List operationId: CpqAssetsContractsActionV2-GET produces: - application/json parameters: - name: accountId in: path description: Id of Account for Asset List required: true type: string x-example: 001f4000007hynC - name: includes in: query description: >- type of account which the asset belongs to - billedAssets|serviceAssets|noContractAssets|customizedFilterAssets required: false type: string x-example: billedAssets - name: hierarchy in: query description: level of hierarchy for assets required: false type: integer format: int32 - name: pagesize in: query description: Number of records to be returned required: false type: integer x-example: 10 - name: effectiveAssetsDateFilter in: query description: >- 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. required: false type: string x-example: 2017-04-05T07:00:00.000Z responses: '200': description: | ### 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": [] } }] } ``` '/accounts/{accountid}': get: description: >- Get Account properties given acount Id. Rest Handler - CpqGetAccountsActionV2 Method Invoked - getAccounts tags: - Customer summary: Get Account Info operationId: CpqGetAccountsActionV2-GET produces: - application/json parameters: - $ref: '#/parameters/accountId' - $ref: '#/parameters/fields' responses: '200': description: | ### Get Account properties of the specified account id ```json { "totalSize": 1, "messages": [], "records": [{ "messages": [], "displaySequence": -1, "OwnerId": "0051I000000Qvb4QAC", "Name": "AR3" }] } ``` '/accounts/{accountid}/contracts': get: description: >- Get a list of contracts given account Id. Rest Handler - CpqContractsAccountsActionV2 Method Invoked - getContracts tags: - Customer summary: Get List of Contracts operationId: CpqContractsAccountsActionV2- GET produces: - application/json parameters: - $ref: '#/parameters/accountId' responses: '200': description: | ### 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": {} } }] } ``` '/assets/{assetId}/pricing': parameters: - $ref: '#/parameters/assetId' get: tags: - Customer summary: Get price details of a asset. description: >- Get price details of a asset. Rest Handler - APIAssetsPricingV2 Method Invoked - getAssetPriceDetail operationId: APIAssetsPricingV2-GET parameters: - $ref: '#/parameters/accountId' - $ref: '#/parameters/effectiveAssetsDateFilter' - $ref: '#/parameters/pagesize' - $ref: '#/parameters/hierarchy' - name: include in: query description: if all assets need to return. required: false type: string x-example: allAssets produces: - application/json responses: '200': description: | 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 } ] } } ] } ``` '/contracts/{contractId}/assets': get: description: >- Get a list of assets given contract id. Rest Handler - CpqAssetsContractsActionV2 Method Invoked - getAssetsByContract tags: - Contract summary: Get Asset List operationId: CpqAssetsContractsActionV2- GET produces: - application/json parameters: - name: contractId in: path description: Id of Contract for Asset List - Required required: true type: string x-example: 800f4000000gLAA - $ref: '#/parameters/hierarchy' - $ref: '#/parameters/pagesize' - name: effectiveAssetsDateFilter in: query description: >- 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. required: false type: string x-example: 2017-04-05T07:00:00.000Z responses: '200': description: | ### 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: [] } ``` schema: $ref: '#/definitions/Asset' '/cpq/carts/{cartid}/pricelists': get: description: >- Get pricelists avaialble to a cart Id. Rest Handler CpqGetPriceListsActionV2 Method Invoked getPricelists tags: - Cart summary: Get Pricelists Available to a Cart operationId: CpqGetPriceListsActionV2 produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/pagesize' responses: '200': description: | ### 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" }] } ``` schema: $ref: '#/definitions/PriceList' '/cpq/carts/{cartid}/price': get: description: >- Get Carts Line Item Prices Rest Handler - APIPriceCartsCpqV2 Method Invoked - tags: - Cart summary: Returns Flat List of Field Values Without Executing Pricing. operationId: APIPriceCartsCpqV2-GET produces: - application/json parameters: - $ref: '#/parameters/cartId' - name: priceDetailsFields in: query description: Comma separated list of fields to retrieve price values for required: false type: string x-example: 'vlocity_cmt__OneTimeCharge__c,vlocity_cmt__RecurringCharge__c' responses: '200': description: cart items schema: type: object items: $ref: '#/definitions/result' post: tags: - Cart summary: Run pricing for given items to a Cart description: > Run pricing for one or more items to a specified cart. Rest Handler - APIPriceCartsCpqV2 Method Invoked - priceCart operationId: APIPriceCartsCpqV2-POST produces: - application/json consumes: - application/json parameters: - $ref: '#/parameters/cartId' - name: requestBody in: body description: | Request Body with cartId - required ### Validate Cart Request Example ```json { "items": [ "8024600000CHsUa", "8024600000CCpco" ] } ``` required: false schema: $ref: '#/definitions/ValidateCartBody' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/PostPricingResponse' '/cpq/carts/{cartid}/items/{itemId}/pricing': get: description: >- 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 tags: - Cart summary: Retrieves the price waterfall for a price. operationId: APIItemsCartsPricingCpqV2-GET produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/itemId' - $ref: '#/parameters/fields' responses: '200': description: | ### 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 } ] } } ]} ``` schema: type: object items: $ref: '#/definitions/result' post: tags: - Cart summary: 'Applies an adjustment (discount, markup, or override to a price).' description: > 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 operationId: APIItemsCartsPricingCpqV2-POST produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/itemId' - name: requestBody in: body description: | 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" } ] } ``` required: true schema: $ref: '#/definitions/result' responses: '200': description: >- 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: tags: - Cart description: >- 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 summary: Deletes an existing adjustment. operationId: APIItemsCartsPricingCpqV2 -DELETE produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/itemId' - name: adjustmentId in: query description: Adjustment Id type: string x-example: a2H46000000hj2ZEAQ responses: '200': description: | ### 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 }] } } } } } ``` '/cpq/carts/{cartid}/items/{itemId}/expand': get: description: >- This API retrieves next level of children under a particular product in a bundle (in cart) Rest Handler - APIExpandItemCartsCpqv2 Method Invoked - getExpandedItems tags: - Cart summary: Expand Parent Item To Display Next Level Children. operationId: APIExpandItemCartsCpqv2-GET produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/itemId' - $ref: '#/parameters/productHierarchyPath' responses: '200': description: | ### 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": [] } }] } }] } ``` schema: type: object items: $ref: '#/definitions/result' '/cpq/carts/{cartid}/items/{itemId}/itemattributes': put: description: >- 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 tags: - Cart summary: Update Item Attributes operationId: APIItemAttributesItemsCartsCpqV2-PUT produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/itemId' - name: price in: query description: pricing evaluation required: false type: boolean x-example: true - $ref: '#/parameters/validate' - name: requestBody in: body description: | Request Body with input fields - Required ### Update Item Attributes request example ```json { "fields":null, "items":{JSONRECORD}, "itemId":"8021I000001kvWeQAI", "cartId":"8011I000000TOcSQAW", "methodName":"putItemAttributes", "price":true,"validate":true } ``` required: true schema: $ref: '#/definitions/Item' responses: '200': description: | ### 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 } ``` schema: type: object items: $ref: '#/definitions/result' '/cpq/carts/{cartid}/items/clone': post: description: Clones line items in the cart. tags: - Cart summary: Clones line items in the cart. operationId: CpqCloneCartItemActionV2-POST produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/itemId' - name: requestBody in: body description: | Request Body with input fields - Required ### Clone line item request example ```json { "methodName": "cloneItems", "cartId": "801360000008eNU", "items":[ {"itemId":"01t36000000pfcKAAQ"}] } ``` required: true schema: $ref: '#/definitions/Item' responses: '200': description: | ### Clone 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" => {} } } } }, } ``` '/cpq/carts/{cartid}/items/checkout': post: description: Checkout items in the cart. tags: - Cart summary: Checkout items in the cart. operationId: APICheckoutItemsCartsCPQV2-POST produces: - application/json parameters: - $ref: '#/parameters/cartId' - $ref: '#/parameters/ContextId' - $ref: '#/parameters/objectTypeToIdsToClone' - $ref: '#/parameters/validateSubmittedXLI' - $ref: '#/parameters/checkOrderStatus' - $ref: '#/parameters/provisioningStatus' - name: requestBody in: body schema: type: object required: - cartId properties: cartId: type: string description: Id of the context cart ContextId: type: string description: Context id objectTypeToIdsToClone: type: string description: object type to list of ids to checkout example: 'OrderItem:8021N000008NG5t_8021N000008NG5s' validateSubmittedXLI: type: boolean description: > flag to decide whether to run the pre submit validation or not. The validation will check that all submitted line items have a Fullfilment Status of 'Activated' and that full bundles are submitted. default: false checkOrderStatus: type: boolean description: >- flag to decide whether to verify the order status prior to check out or not. default: true provisioningStatus: type: string description: >- determines the provisioning status to use for newly created assets. default: Active description: | Request Body with input fields - Required ### Checkout request example ```json { "methodName":"checkout", "cartId":"8011N000001Fkrv", "ContextId":"8011N000001Fkrv", "objectTypeToIdsToClone":"OrderItem:8021N000008NG5t_8021N000008NG5s", "validateSubmittedXLI":true, "checkOrderStatus":true, "provisioningStatus":"Active" } ``` required: true responses: '200': description: | ### Submit succeeded ```json { "totalSize":1, "records":[ { "displaySequence":-1, "id":"0011N00001dwl3aQAA", "objectType":"Account", "clonedObjectIds":"[\"02i1N000007pCkGQAU\"]" } ] } ``` '214': description: | ### Submit failed. Sample response if validate is true and some or all the line items are not activated ```json { "totalSize":0, "messages":[ { "code":"214", "severity":"ERROR", "message":"The following line items are not activated 8021N00000BS6TFQA1,8021N00000BS6VPQA1,8021N00000BS6VQQA1,8021N00000BS6TGQA1,8021N00000BS6THQA1,8021N00000BS6TKQA1,8021N00000BS6TLQA1,8021N00000BS6TMQA1,8021N00000BS6TNQA1" } ] } ``` ### Submit failed.Sample response if validate is true and some bundles are incomplete and some or all line items are not activated ```json { "totalSize":0, "messages":[ { "code":"214", "severity":"ERROR", "message":"The following line items are not activated 8021N00000BS6VQQA1 | Please submit the full bundle for the following line item(s) 8021N00000BS6VQQA1" }] } ``` '/cpq/carts/{cartid}/cancel': post: description: To cancel a order. First, the user should run the preValidate api to confirm that the order can be cancelled by the Cancel Order api. Then, run the Cancel Order api. tags: - Cart summary: Cancel a cart. operationId: APICancelCartsCPQV2-POST produces: - application/json parameters: - $ref: '#/parameters/cartId' - name: requestBody in: body schema: type: object required: - cartId properties: cartId: type: string description: Id of the context cart description: | Request Body with input fields - Required ### Checkout request example ```json { "methodName":"cancelCart", "cartId":"8011N000001Fkrv" } ``` required: true responses: '200': description: | ### Submit succeeded ```json {"totalSize":1,"messages":[{"code":"305","severity":"INFO","message":"Your order has been cancelled."}],"records":[{"displaySequence":-1,"vlocity_cmt__OrderStatus__c":"Cancelled","vlocity_cmt__IsChangesAllowed__c":false}]} ``` put: description: This API is to send updates on cancellations. When an order is cancelled, a Supplemental Order is created and submitted to XOM. XOM acts on that order and either responds with success or rejected statuses. This call lets XOM to update the status of Supplemental Order in CMT. tags: - Cart summary: Send updates on cancellations. operationId: APICancelCartsCPQV2-PUT produces: - application/json parameters: - $ref: '#/parameters/cartId' - name: requestBody in: body schema: type: object required: - cartId properties: cartId: type: string description: Id of the context cart description: | Request Body with input fields - Required ### Checkout request example ```json { "methodName":"cancelCart", "cartId":"8011N000001Fkrv" } ``` required: true responses: '200': description: | ### Submit succeeded ```json {} ``` '/cpq/carts/{cartid}/prevalidate': post: description: This API will pre-validate whether an order can be cancelled or not. It calls the Order Management (XOM) and retrieves the realtime PONR status. The user should first run this preValidate api, then based on an affirmative response, the user can run the cancelCart api. tags: - Cart summary: Prevalidate before cancelling a cart. operationId: APIPrevalidateCartsCPQV2-POST produces: - application/json parameters: - $ref: '#/parameters/cartId' - name: requestBody in: body schema: type: object required: - cartId properties: cartId: type: string description: Id of the context cart description: | Request Body with input fields - Required ### Checkout request example ```json { "methodName":"preValidate", "cartId":"8011N000001Fkrv" } ``` required: true responses: '200': description: | ### Submit succeeded ```json {"totalSize":1,"records":[{"actions":{"cancelcart":{"rest":{"params":{},"method":null,"link":null},"remote":{"params":{"methodName":"createSupplementalOrder","cartId":"8015A0000033OstQAE"}},"client":{"params":{}}},"unfreezeorder":{"rest":{"params":{},"method":null,"link":null},"remote":{"params":{"methodName":"unfreezeOrder","cartId":"8015A0000033OstQAE"}},"client":{"params":{}}}},"displaySequence":-1,"cmt_v103_1__OrderStatus__c":"In Progress","cmt_v103_1__IsChangesAllowed__c":true,"Id":"8015A0000033OstQAE"}]} ``` '/cpq/carts/{cartid}/unfreeze': post: description: This API is to unfreeze an order. If user decides not to proceed with cancellation. On clicking "No" in the Cancel Confirmation box on CPQ, OM unfreeze API to be called to restore execution of original order. tags: - Cart summary: Unfreeze an order. operationId: APIUnfreezeOrderCPQV2-POST produces: - application/json parameters: - $ref: '#/parameters/cartId' - name: requestBody in: body schema: type: object required: - cartId properties: cartId: type: string description: Id of the context cart description: | Request Body with input fields - Required ### Checkout request example ```json { "methodName":"unfreezeOrder", "cartId":"8011N000001Fkrv" } ``` required: true responses: '200': description: | ### Submit succeeded ```json [{"statusCode":200,"type":"rpc","tid":25,"ref":false,"action":"tsahu_v1031.CardCanvasController","method":"doGenericInvoke","result":"{\"totalSize\":0}"}] ``` /listsofvalues: get: description: >- Retrieves time plans, time policies, and adjustment codes. The Price Adjustment dialog box enables a user to pick a time plan and time policy to associate with a recurring adjustment or to pick a code that defines an adjustment for a specific price, such as a recurring charge, one-time charge, one-time total, and so on. Rets Handler - listOfValues Method Invoked - getListsOfValues tags: - Platform summary: Get list of values operationId: getListsOfValues parameters: - name: listkeys in: query description: The type of lists for which to retrieve values required: false type: string x-example: 'TimePlans,TimePolicies, AdjustmentCodes' - name: fields in: query description: List of fields for which to retrieve adjustment codes required: false type: string x-example: vlocity_cmt__OneTimeCharge__c - name: cartId in: query description: 'Opportunity, quote, or order ID to use as context ID' required: false type: string x-example: 80146000000goGvAAI - name: ID in: query description: Line item ID required: false type: string x-example: 80246000000gaR9AAI - name: PricingVariableCode in: query description: Pricing variable code associated with the price field required: false type: string x-example: OT_STD_PRC responses: '200': description: | ### Response for get list of values ```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 } ] } } ] } ``` /cpq/catalogs/: get: description: >- Return the entire catalog and its products. Rest Handler - APICatalogsCpqV2 Method Invoked - getCatalogHierarchy tags: - Catalog summary: Get Catalog and its Products operationId: APICatalogsCpqV2 - GET parameters: - $ref: '#/parameters/pagesize' - $ref: '#/parameters/offsetSize' - $ref: '#/parameters/hierarchy' - $ref: '#/parameters/sortBy' - name: catalogId in: query description: Catalog Id required: false type: string x-example: a0F41000001DdP6EAK - name: contextId in: query description: Cart Id required: false type: string x-example: 80141000000HaKWAA0 responses: '200': description: |- ## Response to get a specific catalog { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "nextcatalogs": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt/v2/cpq/catalogs/?hierarchy=-1&offsetSize=1&pagesize=1&includeProducts=true" }, "remote": { "params": { "includeProducts": true, "pagesize": 1, "offsetSize": 1, "hierarchy": -1, "methodName": "getCatalog" } }, "client": { "params": {} } }, "getproducts": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt/v2/cpq/carts/80141000000HaKWAA0/products?category=a0F41000001DdP6EAK" }, "remote": { "params": { "contextId": "80141000000HaKWAA0", "catalogId": "a0F41000001DdP6EAK", "methodName": "getCartsProducts" } }, "client": { "params": {} } } }, "displaySequence": -1, "attributes": { "type": "vlocity_cmt__Catalog__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__Catalog__c/a0F41000001DdP6EAK" }, "Id": "a0F41000001DdP6EAK", "OwnerId": "00541000000beGqAAI", "IsDeleted": false, "Name": "Test Catalog", "CreatedDate": "2016-11-29T04:42:48.000+0000", "CreatedById": "00541000000beGqAAI", "LastModifiedDate": "2016-11-29T04:43:46.000+0000", "LastModifiedById": "00541000000beGqAAI", "SystemModstamp": "2016-11-30T11:07:39.000+0000", "LastViewedDate": "2016-12-09T04:59:31.000+0000", "LastReferencedDate": "2016-12-09T04:59:31.000+0000", "vlocity_cmt__IsActive__c": true, "vlocity_cmt__IsCatalogRoot__c": true, "catalogId": "a0F41000001DdP6EAK", "cartId": "80141000000HaKWAA0", "catalogName": "Test Catalog", "childCatalogs": { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "getproducts": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt//v2/cpq/carts/80141000000HaKWAA0/products?category=a0F41000001DdPBEA0" }, "remote": { "params": { "contextId": "80141000000HaKWAA0", "catalogId": "a0F41000001DdPBEA0", "methodName": "getCartsProducts" } }, "client": { "params": {} } } }, "displaySequence": -1, "attributes": { "type": "vlocity_cmt__Catalog__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__Catalog__c/a0F41000001DdPBEA0" }, "Id": "a0F41000001DdPBEA0", "OwnerId": "00541000000beGqAAI", "IsDeleted": false, "Name": "Sub Cat 1", "CreatedDate": "2016-11-29T04:43:37.000+0000", "CreatedById": "00541000000beGqAAI", "LastModifiedDate": "2016-11-29T04:43:37.000+0000", "LastModifiedById": "00541000000beGqAAI", "SystemModstamp": "2016-12-02T11:08:26.000+0000", "LastViewedDate": "2016-12-01T21:06:18.000+0000", "LastReferencedDate": "2016-12-01T21:06:18.000+0000", "vlocity_cmt__IsActive__c": true, "vlocity_cmt__IsCatalogRoot__c": false, "catalogId": "a0F41000001DdPBEA0", "cartId": "80141000000HaKWAA0", "catalogName": "Sub Cat 1", "childCatalogs": { "totalSize": 1, "messages": [], "records": [{ "messages": [], "actions": { "getproducts": { "rest": { "params": {}, "method": "GET", "link": "/services/apexrest/vlocity_cmt//v2/cpq/carts/80141000000HaKWAA0/products?category=a0F41000001DgvvEAC" }, "remote": { "params": { "contextId": "80141000000HaKWAA0", "catalogId": "a0F41000001DgvvEAC", "methodName": "getCartsProducts" } }, "client": { "params": {} } } }, "displaySequence": -1, "attributes": { "type": "vlocity_cmt__Catalog__c", "url": "/services/data/v38.0/sobjects/vlocity_cmt__Catalog__c/a0F41000001DgvvEAC" }, "Id": "a0F41000001DgvvEAC", "OwnerId": "00541000000beGqAAI", "IsDeleted": false, "Name": "Sub Cat 1.1", "CreatedDate": "2016-11-29T18:38:09.000+0000", "CreatedById": "00541000000beGqAAI", "LastModifiedDate": "2016-11-29T18:38:09.000+0000", "LastModifiedById": "00541000000beGqAAI", "SystemModstamp": "2016-12-02T11:08:26.000+0000", "LastViewedDate": "2016-12-01T22:52:54.000+0000", "LastReferencedDate": "2016-12-01T22:52:54.000+0000", "vlocity_cmt__IsActive__c": true, "vlocity_cmt__IsCatalogRoot__c": false, "catalogId": "a0F41000001DgvvEAC", "cartId": "80141000000HaKWAA0", "catalogName": "Sub Cat 1.1" }] } }] } }] } ## Response to get list of catalogs with pagination { "totalSize":1, "actions": { "nextcatalogs": { "rest":{ "params":{}, "method":"GET", "link":"/services/apexrest/vlocity_cmt/v2/cpq/catalogs/?hierarchy=-1&offsetSize=1&pagesize=1&includeProducts=false" }, "remote":{ "params":{ "includeProducts":false, "pagesize":1, "offsetSize":1, "hierarchy":-1, "methodName":"getCatalog" } }, "client":{ "params":{} } } }, "records":[ { "displaySequence":-1, "attributes":{ "type":"vlocity_cmt__Catalog__c", "url":"/services/data/v42.0/sobjects/vlocity_cmt__Catalog__c/a0D0a00000Ges3cEAB" }, "Id":"a0D0a00000Ges3cEAB", "OwnerId":"0050a00000JIgxVAAT", "IsDeleted":false, "Name":"First", "CreatedDate":"2018-03-01T04:31:50.000+0000", "CreatedById":"0050a00000JIgxVAAT", "LastModifiedDate":"2018-03-01T04:59:18.000+0000", "LastModifiedById":"0050a00000JIgxVAAT", "SystemModstamp":"2018-03-03T01:04:14.000+0000", "LastViewedDate":"2018-03-05T11:06:51.000+0000", "LastReferencedDate":"2018-03-05T11:06:51.000+0000", "vlocity_cmt__CatalogCode__c":"Catalog_f", "vlocity_cmt__GlobalKey__c":"55d205fa-9271-c00f-1d33-8a21c62490ef", "vlocity_cmt__IsActive__c":true, "vlocity_cmt__IsCatalogRoot__c":true, "catalogId":"a0D0a00000Ges3cEAB", "catalogName":"First" } ] } ## Response with sorting (Name_DESC) and default pagination { "totalSize":2, "records":[ { "displaySequence":-1, "attributes":{ "type":"vlocity_cmt__Catalog__c", "url":"/services/data/v42.0/sobjects/vlocity_cmt__Catalog__c/a0D0a00000Ges3hEAB" }, "Id":"a0D0a00000Ges3hEAB", "OwnerId":"0050a00000JIgxVAAT", "IsDeleted":false, "Name":"Second", "CreatedDate":"2018-03-01T04:32:18.000+0000", "CreatedById":"0050a00000JIgxVAAT", "LastModifiedDate":"2018-03-01T04:59:40.000+0000", "LastModifiedById":"0050a00000JIgxVAAT", "SystemModstamp":"2018-03-03T01:04:14.000+0000", "LastViewedDate":"2018-03-01T08:12:34.000+0000", "LastReferencedDate":"2018-03-01T08:12:34.000+0000", "vlocity_cmt__GlobalKey__c":"85057565-e71e-2d6e-3713-3cd437750bcb", "vlocity_cmt__IsActive__c":true, "vlocity_cmt__IsCatalogRoot__c":true, "catalogId":"a0D0a00000Ges3hEAB", "catalogName":"Second" }, { "displaySequence":-1, "attributes":{ "type":"vlocity_cmt__Catalog__c", "url":"/services/data/v42.0/sobjects/vlocity_cmt__Catalog__c/a0D0a00000Ges3cEAB" }, "Id":"a0D0a00000Ges3cEAB", "OwnerId":"0050a00000JIgxVAAT", "IsDeleted":false, "Name":"First", "CreatedDate":"2018-03-01T04:31:50.000+0000", "CreatedById":"0050a00000JIgxVAAT", "LastModifiedDate":"2018-03-01T04:59:18.000+0000", "LastModifiedById":"0050a00000JIgxVAAT", "SystemModstamp":"2018-03-03T01:04:14.000+0000", "LastViewedDate":"2018-03-05T11:06:51.000+0000", "LastReferencedDate":"2018-03-05T11:06:51.000+0000", "vlocity_cmt__CatalogCode__c":"Catalog_f", "vlocity_cmt__GlobalKey__c":"55d205fa-9271-c00f-1d33-8a21c62490ef", "vlocity_cmt__IsActive__c":true, "vlocity_cmt__IsCatalogRoot__c":true, "catalogId":"a0D0a00000Ges3cEAB", "catalogName":"First" } ] } /stringtranslations: get: description: >- Return string translations. Rest Handler - APIStringTranslationsV2 Method Invoked - getStringTranslations tags: - StringTranslations summary: Get string translations operationId: APIStringTranslationsV2 - GET parameters: - $ref: '#/parameters/filters' - $ref: '#/parameters/pagesize' - $ref: '#/parameters/offsetSize' - $ref: '#/parameters/searchBy' - $ref: '#/parameters/sortBy' - $ref: '#/parameters/id' responses: '200': description: |- ## Response to get first page of string transaltions ``` json { "totalSize":20, "actions":{ "nexttranslation":{ "rest":{ "params":{ }, "method":"GET", "link":"/services/apexrest/cmt_v102/v2/stringtranslations?pagesize=20&offsetSize=20" }, "remote":{ "params":{ } }, "client":{ "params":{ } } } }, "records":[ { "displaySequence":-1, "Id":"a3b1N000000pfpLQAQ", "Name":"ar-fi", "vlocity_cmt__StringId__c":"a3c1N0000016TkaQAE", "vlocity_cmt__Translation__c":"ar-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/a3c1N0000016TkaQAE" }, "Id":"a3c1N0000016TkaQAE", "vlocity_cmt__BaseString__c":"AR" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpNQAQ", "Name":"ar", "vlocity_cmt__StringId__c":"a3c1N0000016TkaQAE", "vlocity_cmt__Translation__c":"ar", "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/a3c1N0000016TkaQAE" }, "Id":"a3c1N0000016TkaQAE", "vlocity_cmt__BaseString__c":"AR" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpOQAQ", "Name":"acc-1-fr", "vlocity_cmt__StringId__c":"a3c1N0000016TkbQAE", "vlocity_cmt__Translation__c":"acc-1-fr", "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/a3c1N0000016TkbQAE" }, "Id":"a3c1N0000016TkbQAE", "vlocity_cmt__BaseString__c":"Acc-1" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpPQAQ", "Name":"hr_fr", "vlocity_cmt__StringId__c":"a3c1N0000016TkbQAE", "vlocity_cmt__Translation__c":"hr_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/a3c1N0000016TkbQAE" }, "Id":"a3c1N0000016TkbQAE", "vlocity_cmt__BaseString__c":"Acc-1" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpRQAQ", "Name":"not changes", "vlocity_cmt__StringId__c":"a3c1N0000016TkfQAE", "vlocity_cmt__Translation__c":"not changes", "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/a3c1N0000016TkfQAE" }, "Id":"a3c1N0000016TkfQAE", "vlocity_cmt__BaseString__c":"SPE-26" } }, { "displaySequence":-1, "Id":"a3b1N000000pfpSQAQ", "Name":"spe<26>", "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" } } ] } ``` schema: $ref: '#/definitions/getStringTranslationResponse' put: tags: - StringTranslations summary: Update string translations. description: | update string translations. operationId: APIStringTranslationsV2-PUT produces: - application/json consumes: - application/json parameters: - name: requestBody in: body description: |- ### 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" } ] ``` required: true schema: $ref: '#/definitions/UpdateStringTranslationRequest' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/UpdateStringTranslationResponse' post: tags: - StringTranslations summary: Create string translations. description: | create string translations. operationId: APIStringTranslationsV2-POST produces: - application/json consumes: - application/json parameters: - name: requestBody in: body description: |- ### 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" } ] ``` required: true schema: $ref: '#/definitions/CreateStringTranslationRequest' responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/CreateStringTranslationResponse' /stringtranslations/id: delete: tags: - StringTranslations summary: Remove string translations description: > Remove string translations. Rest Handler - APIStringTranslationsV2 Method Invoked - deleteStringTranslations operationId: APIStringTranslationsV2-DELETE parameters: - name: id in: path required: true description: salesforce id type: string x-example: a4D41000000TaQ2EAK produces: - application/json responses: '200': description: >- OK - API request processed. Look for messages in the response to determine if it succeeded or failed. schema: $ref: '#/definitions/deleteStringTranslationsResponse' /stringtranslations/dictionary/domain/localeCode: get: description: >- Return dictionary of given domain and locale code. Rest Handler - APIDictionaryStringTranslationsV2 Method Invoked - getDictionary tags: - StringTranslations summary: Get dictionary operationId: APIDictionaryStringTranslationsV2 - GET parameters: - name: domain in: path required: true type: string description: domain is CPQ - Required x-example: CPQ - name: localeCode in: path required: true type: string description: 'localeCode e.g fr, en_US - Required' x-example: fr - name: page in: query required: false type: number description: dictionary is divided into multiple pages. x-example: 1 - name: pageSize in: query required: false type: number description: pageSize is number of words return in a page. x-example: 16000 responses: '200': description: |- ## 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" } } ] } ``` schema: $ref: '#/definitions/dictionaryResponse' definitions: result: type: object required: - totalSize - messages - records properties: totalSize: type: integer actions: type: array items: type: object properties: prev: $ref: '#/definitions/Action' next: $ref: '#/definitions/Action' messages: $ref: '#/definitions/Error' records: type: array items: $ref: '#/definitions/Account' Account: type: object properties: Name: type: string PhotoUrl: type: string OwnerId: type: string PriceList: type: object properties: Id: type: string example: a2Lf4000000TvFmEAK Asset: type: object description: the Asset List properties: Name: $ref: '#/definitions/JsonField' SerialNumber: $ref: '#/definitions/JsonField' Quantity: $ref: '#/definitions/JsonField' Status: $ref: '#/definitions/JsonField' vlocity_cmt__ProvisioningStatus__c: $ref: '#/definitions/JsonField' vlocity_cmt__RecurringTotal__c: $ref: '#/definitions/JsonField' vlocity_cmt__OneTimeTotal__c: $ref: '#/definitions/JsonField' childAssets: $ref: '#/definitions/result' CartPromotions: allOf: - $ref: '#/definitions/JsonResult' - type: object properties: records: type: array items: $ref: '#/definitions/CartPromotion' AccountAppliedPromotions: allOf: - $ref: '#/definitions/JsonResult' - type: object properties: records: type: array items: $ref: '#/definitions/AppliedPromotion' CartPromotion: type: object description: Representation of an available or applied promotion. properties: displaySequence: type: integer description: Sequence to display in the UI. readOnly: true example: 0 Name: type: string description: (Available promotions only) Name of the promotion. readOnly: true example: Summer TV Blowout vlocity_cmt__Code__c: type: string description: (Available promotions only) Code the identifies the given promotion. readOnly: true example: DEC123 vlocity_cmt__Description__c: type: string description: (Available promotions only) Description of the promotion. readOnly: true example: 25% Off HD Promo Id: type: string description: (Available promotions only) Id of the promotion (Salesforce Id). readOnly: true example: a2B37000000u5PEEAY category: type: string enum: - qualified - disqualified description: >- Qualification Category - Whether the promotion is *qualified* or *disqualified* for this cart. readOnly: true example: qualified qualifications: type: array items: $ref: '#/definitions/Qualification' readOnly: true vlocity_cmt__Sequence__c: allOf: - $ref: '#/definitions/JsonField' - type: object description: >- (Applied promotions only) Sequence in which this promotion is applied to the cart. vlocity_cmt__PromotionId__r: allOf: - $ref: '#/definitions/LinkField' - type: object description: (Applied promotions only) Id of the promotion. vlocity_cmt__CommitmentStartDate__c: allOf: - $ref: '#/definitions/JsonField' - type: object description: (Applied promotions only) vlocity_cmt__CommitmentEndDate__c: allOf: - $ref: '#/definitions/JsonField' - type: object description: (Applied promotions only) vlocity_cmt__PricingStartDate__c: allOf: - $ref: '#/definitions/JsonField' - type: object description: (Applied promotions only) vlocity_cmt__PricingEndDate__c: allOf: - $ref: '#/definitions/JsonField' - type: object description: (Applied promotions only) vlocity_cmt__RequestDate__c: allOf: - $ref: '#/definitions/JsonField' - type: object description: (Applied promotions only) vlocity_cmt__AppliesTo__c: allOf: - $ref: '#/definitions/JsonField' - type: object description: (Applied promotions only) AppliedPromotion: type: object description: >- Representation of an applied promotion which is applied to an account, contract or asset(s). properties: vlocity_cmt__Sequence__c: $ref: '#/definitions/JsonField' vlocity_cmt__PromotionId__r: $ref: '#/definitions/LinkField' vlocity_cmt__PromotionDescription: $ref: '#/definitions/JsonField' vlocity_cmt__CommitmentStartDate__c: $ref: '#/definitions/JsonField' vlocity_cmt__CommitmentEndDate__c: $ref: '#/definitions/JsonField' vlocity_cmt__PricingStartDate__c: $ref: '#/definitions/JsonField' vlocity_cmt__PricingEndDate__c: $ref: '#/definitions/JsonField' vlocity_cmt__CancellationDate__c: $ref: '#/definitions/JsonField' vlocity_cmt__AppliedDate__c: $ref: '#/definitions/JsonField' vlocity_cmt__AppliesTo__c: $ref: '#/definitions/JsonField' category: type: string enum: - qualified - disqualified description: >- Qualification Category - Whether the applied promotion is now *qualified* or *disqualified* for the current state of the customer account. readOnly: true example: qualified qualifications: type: array items: $ref: '#/definitions/Qualification' readOnly: true Qualification: type: object description: >- Representation of a qualification required for the object it describes and whether it passes or fails for that object. properties: type: type: string description: 'Type of qualification such as rule set, rule or rule condition.' enum: - RuleSet - Rule - RuleCondition name: type: string description: Name of the qualification. qualifies: type: boolean description: Whether this qualification is satisfied or not. failureMessage: type: string description: 'If not satisfied, a message explaining why not.' qualifications: type: array items: $ref: '#/definitions/Qualification' AccountDisqualifiedPromotions: allOf: - $ref: '#/definitions/JsonResult' - type: object properties: records: type: array items: $ref: '#/definitions/AppliedPromotion' LineItem: type: object description: The Line Item object properties: itemId: $ref: '#/definitions/JsonField' Id: $ref: '#/definitions/JsonField' Pricebook2Id__r: $ref: '#/definitions/LinkField' Product2Id__r: $ref: '#/definitions/LinkField' ProductCode: $ref: '#/definitions/JsonField' vlocity_cmt__EffectiveQuantity__c: $ref: '#/definitions/JsonField' vlocity_cmt__OneTimeTotal__c: $ref: '#/definitions/JsonField' vlocity_cmt__RecurringCharge__c: $ref: '#/definitions/JsonField' attributeCategory: $ref: '#/definitions/attributeCategory' attributeCategory: properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' Name: type: string example: Category1.0 Id: type: string example: a0936000002rQiFAAU Code: type: string example: Al_size productAttributes: type: array items: $ref: '#/definitions/productAttribute' productAttribute: type: object description: Product Attribute properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' Name: type: string example: Attribute1.0 attributeId: type: string example: a0A36000007YtQIEA0 label: type: string example: Description values: type: array items: $ref: '#/definitions/attributeValue' attributeValue: type: object description: Attribute Value properties: id: type: string example: 1 name: type: string example: 1 label: type: string example: label1 CreateCartBody: type: object discriminator: subaction required: - subaction properties: subaction: type: string description: | Type of cart to create and method to use to create it. enum: - createOrder - createQuote - createOppty - assetToQuote - assetToOrder - assetChangeSite fields: type: string description: 'List of fields to return in the response, separated by commas.' CreateOrderBody: description: A representation to create a new order. allOf: - $ref: '#/definitions/CreateCartBody' - type: object required: - subaction - inputFields properties: inputFields: type: array description: >- 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. items: type: object 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 CreateQuoteBody: description: A representation to create a new quote. allOf: - $ref: '#/definitions/CreateCartBody' - type: object required: - subaction - inputFields properties: inputFields: type: array description: >- 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. items: type: object 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: description: A representation to create a new opportunity. allOf: - $ref: '#/definitions/CreateCartBody' - type: object required: - subaction - inputFields properties: inputFields: type: array description: >- 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. items: type: object 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: description: A representation to create a new order from an array of customer assets. allOf: - $ref: '#/definitions/CreateCartBody' - type: object required: - subaction - inputFields properties: inputFields: type: array description: >- 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. items: type: object 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 UpdateCartBody: description: A representation to update the cart. allOf: - type: object required: - inputFields properties: inputFields: type: array description: >- 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. items: type: object example: inputFields: - Pricebook2Id: 01s6A000002Y7wz fields: 'Id,Name' AddCartItemBody: description: A representation to update the cart. allOf: - type: object required: - inputFields properties: inputFields: type: array description: >- 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. items: type: object 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 CreateCartResult: description: Created cart. type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' actions: type: array readOnly: true items: type: object properties: action: $ref: '#/definitions/Action' records: type: array items: $ref: '#/definitions/Cart' CartAttributeDetail: description: Get Cart Attribute Details. type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' records: type: array items: $ref: '#/definitions/attributeCategory' CartResult: type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 records: type: array items: $ref: '#/definitions/CartDetail' SiteResult: description: A detailed representation of a given cart. allOf: - $ref: '#/definitions/JsonResult' CartDetail: type: object properties: messages: $ref: '#/definitions/Messages' displaySequence: type: integer description: Sequence to display in the UI. example: -1 details: description: Cart details. allOf: - $ref: '#/definitions/JsonResult' - type: object properties: records: type: array items: type: object Id: type: string example: 8016A000000bwElQAI Name: type: string example: New customer order EffectiveDate: type: string format: date example: '2017-12-25' AccountId: type: string example: 0016A0000053kHN Account.Name: type: string example: Acme Inc. EffectiveRecurringTotal__c: type: number format: float EffectiveOneTimeTotal__c: type: number format: float EffectiveOrderTotal__c: type: number format: float OrderNumber: description: Order Number assigned by Salesforce type: string example: '00000141' Status: type: string example: Draft Cart: type: object properties: messages: $ref: '#/definitions/Messages' displaySequence: type: integer description: Sequence to display in the UI. example: -1 Id: type: string example: 8016A000000bwElQAI Name: type: string example: New customer order EffectiveDate: type: string format: date example: '2017-12-25' AccountId: type: string example: 0016A0000053kHN Account.Name: type: string example: Acme Inc. EffectiveRecurringTotal__c: type: number format: float EffectiveOneTimeTotal__c: type: number format: float EffectiveOrderTotal__c: type: number format: float OrderNumber: description: Order Number assigned by Salesforce type: string example: '00000141' Status: type: string example: Draft DeleteCartItem: description: The response when an item is deleted from cart type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' actions: type: array readOnly: true items: type: object properties: action: $ref: '#/definitions/Action' records: type: array items: $ref: '#/definitions/Item' Item: description: The item in the delete type: object properties: messages: $ref: '#/definitions/Messages' Id: type: string example: 80241000000Ha4aAAC ValidateCartBody: description: Request body sent in for validate cart type: object properties: cartId: type: string example: 8011N00000157LkQAI methodName: type: string example: runCartValidation price: type: boolean example: true validate: type: boolean example: true ValidateCartResponse: description: Response for the validate cart type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' actions: type: array readOnly: true items: type: object properties: action: $ref: '#/definitions/Action' records: type: array items: $ref: '#/definitions/Cart' PostPromoCartResponse: description: Response for the add promot to cart. type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' actions: type: array readOnly: true items: type: object properties: action: $ref: '#/definitions/Action' records: type: array items: $ref: '#/definitions/Cart' PostPricingResponse: description: Response for the post pricing of lineItems. type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' actions: type: array readOnly: true items: type: object properties: action: $ref: '#/definitions/Action' GetCartItemResult: description: Response of Get Cart Items type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' records: type: array items: $ref: '#/definitions/CartItem' CartItem: description: Response of Get Cart Items type: object properties: messages: $ref: '#/definitions/Messages' actions: $ref: '#/definitions/Action' itemId: type: string description: itemId example: 01u41000001QPtsAAG GetProductResult: description: The list of products in the selectables type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' actions: type: array readOnly: true items: type: object properties: action: $ref: '#/definitions/Action' records: type: array items: $ref: '#/definitions/Product' Product: description: the product object type: object properties: messages: $ref: '#/definitions/Messages' displaySequence: type: integer description: Sequence to display in the UI. example: -1 Id: type: string example: 01u41000001QPs0AAG Pricebook2Id: type: string example: 01s41000005dPYQAA2 Product2Id: type: string example: 01t41000000sYZQAA2 UnitPrice: type: number format: float example: 1 Name: type: string example: Root 1 IsActive: type: boolean example: true Action: type: object properties: remote: type: object description: JavaScript Remoting URL readOnly: true REST: type: object description: REST URL readOnly: true Messages: type: array items: type: object readOnly: true required: - code - message properties: severity: type: string messageId: type: string code: type: integer format: int32 message: type: string example: Successfully completed Error: type: object required: - code - message properties: severity: type: string description: Severity of the error. Typically "ERROR" messageId: type: string code: type: integer format: int32 message: type: string example: Error Message JsonResult: type: object properties: totalSize: type: integer readOnly: true description: Number of records in the records array. example: 1 messages: $ref: '#/definitions/Messages' records: type: array items: type: object properties: messages: $ref: '#/definitions/Messages' displaySequence: type: integer description: Sequence to display in the UI. example: -1 actions: type: array readOnly: true items: type: object LinkField: type: object properties: Id: type: string Name: type: string Url: type: string JsonField: type: object properties: datatype: type: string fieldName: type: string value: type: string editable: type: boolean hidden: type: boolean dictionary: description: The response for dictionary type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 domain: type: string description: domain is CPQ. example: 'CPQ,' localeCode: type: string description: locale code. example: fr dictionary: type: object additionalProperties: type: object properties: code: type: string text: type: string description: mapping of words/sentences. dictionaryResponse: description: The response when an item is deleted from cart type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 records: type: array items: $ref: '#/definitions/dictionary' stringObject: description: represent string object type: object properties: Id: type: string example: a3b1N000000pfpLQAQ vlocity_cmt__BaseString__c: type: string example: hello stringTranslationObject: description: string translations type: object properties: displaySequence: type: integer description: Sequence to display in the UI. example: -1 Id: type: string example: a3b1N000000pfpLQAQ Name: type: string example: Root 1 vlocity_cmt__StringId__c: type: string example: a3c1N0000016TkaQAE vlocity_cmt__Translation__c: type: string example: hello_fr vlocity_cmt__LocaleCode__c: type: string example: fr vlocity_cmt__StringId__r: type: object $ref: '#/definitions/stringObject' getStringTranslationResponse: description: get string translation response. type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 actions: type: array readOnly: true items: type: object properties: action: $ref: '#/definitions/Action' records: type: array items: $ref: '#/definitions/stringTranslationObject' UpdateStringTranslationRequest: type: object items: $ref: '#/definitions/stringTranslationObject' UpdateStringTranslationResponse: type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' deleteStringTranslationsResponse: type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages' CreateStringTranslationRequest: type: object items: $ref: '#/definitions/stringTranslationObject' CreateStringTranslationResponse: type: object properties: totalSize: type: integer description: Number of records in the records array. readOnly: true example: 1 messages: $ref: '#/definitions/Messages'