APIs for Enterprise Sales Management

You can use the Enterprise Sales Management APIs to create and manage enterprise quotes by calling corresponding Integration Procedures.

Salesforce recommends using the Enterprise Sales Management SDK for Enterprise Sales Management and Lightning Web Components for Enterprise Sales Management to call these APIs instead of calling them directly. The SDK and LWCs improve usability and help you develop compelling UIs by hiding complex API semantics. You can use this Integration Procedure API information to better understand Enterprise Sales Management business processes.

Tip

Posting Data to an Integration Procedure 

To post JSON data to a Enterprise Sales Management Integration Procedure, issue a POST call using a URL formatted as follows:

1/services/apexrest/vlocity_cmt/v1/integrationprocedure/{type}_{subtype}/

Specify the type and subtype of the Integration Procedure, which can be found in its Integration Procedure details page.

To pass input data in a POST call, you can specify a JSON request body.

In the following example POST, the getAll_members Integration Procedure retrieves all quote members for a given quote ID.

1POST
2/services/apexrest/vlocity_cmt/v1/integrationprocedure/getAll_members/

Example POST JSON Data:

1{
2 	"SalesQuoteId": "0Q03h000000TuXGCA0"
3 }

Example Result:

1{
2	"Members": [{
3			"Id": "a5X5w000002KqC9EAK",
4			"QuoteId__c": "0Q05w000001sayRCAQ",
5			"Title__c": "VP",
6			"Address1__c": "Suite 415",
7			"Name": "Mary Sommer",
8			"MemberType__c": "Location",
9			"StreetAddress__c": "123 Main St",
10			"State__c": "CA",
11			"PostalCode__c": "94102",
12			"MSISDN__c": "1234564567",
13			"LastName__c": "Sommer",
14			"FirstName__c": "Mary",
15			"Email__c": "msommer@test.com",
16			"Country__c": "USA",
17			"City__c": "San Francisco"
18		},
19		{
20			"UpsertSuccess": true,
21			"Id": "a5X5w000002KqCAEA0",
22			"QuoteId__c": "0Q05w000001sayRCAQ",
23			"Title__c": "EVP",
24			"Address1__c": "Suite 415",
25			"Name": "Tom Hanks",
26			"MemberType__c": "Subscriber",
27			"StreetAddress__c": "1480 SantaClara St",
28			"State__c": "CA",
29			"PostalCode__c": "95050",
30			"MSISDN__c": "123456489",
31			"LastName__c": "Hanks",
32			"FirstName__c": "Tom",
33			"Email__c": "thanks@test.com",
34			"Country__c": "USA",
35			"City__c": "Santa Clara"
36		}
37	]
38}

Enterprise Sales Management API Descriptions 

Use the API name to POST data to the corresponding Integration Procedure. For the ESM_checkServiceQualification and ESM_checkAddressValidation APIs, see Add API Endpoint to Remote Site Settings.

Some components have been renamed to align with the naming conventions of OmniStudio Standard Runtime, to provide support for it.

Note

APIDescriptionCorresponding Integration Procedure
AddMem_ToQG APIAdd members to a quote group.AddMembersToQGroup
AddQMQGToWC_CopyToEQ APIAdd members and a quote group to the working cart and copy it to the enterprise quote.AddQMQGToWCQLIsCopyToEQ
AddQMQGToWC_CopyToEQBatch APITrigger a batch process to migrate and clone products from the working cart to the enterprise quote.AddQMQGToWCQLIsCopyToEQBatch
b2bExpress_AddProductToCart APIAdd a product to a working cart.b2bExpress_AddProductToCart
b2bExpress_assetConfigData APIStore the information that is displayed on the assets page.getAssetConfigData
b2bExpress_CreateSubOrder APICreate sub-orders for a given quote member. This API returns the record ID of the sub-order created.CreateSubOrder
b2bExpress_DeleteMembers APIDelete members for a given quote member.RemoveMembers
b2bExpress_getAssetsFromAccount APIGet child assets for a given account ID, root asset ID, and page size.getAssetsFromAccount
b2bExpress_SalesOrder APICreate orders for the given quote ID and account ID. This API returns the principal order ID.SalesOrder
b2bExpress_SubmitSubOrder APISubmit an order.SubmitSubOrder
b2bExpress_SubmitSubOrders APISubmit all sub-orders.SubmitSubOrders
b2bExpress_SubOrders APICreate sub-orders for a given quote member.SubOrders
b2bExpress_TemplateConfigData APIFetch Vlocity Document Template details for a given configuration.B2BExpress_TemplateConfigData
b2bExpress_UpdateQtyPrice APIUpdate quantity and reprice order items that belong to a specific group.UpdateQtyPrice
b2bExpress_updateQuantityAndReprice APIUpdate quantity and perform repricing for a given quote ID and quantity.UpdateQuantityAndRepriceCart
CloneEQLIsToWC_PriceCopyBackToEQ APIClone enterprise quote line items (QLIs) to working cart, apply pricing, and copy back to the enterprise quote.CloneEQLIsToWCPriceCopyEQLIs
CloneModifyTo_SalesQLIs APIClone modified working cart quote line items (QLIs) to sales QLIs and delete the working cart.CloneModifyWorkingCartToSalesQLIs
CloneModifyTo_SalesQLIsWQPR APIClone the modified working cart quote line items (QLIs) to sales QLIs, delete the working cart, and update the Quote Product Rollup object.CloneModifyWCToSalesQLIs
CloneSalesQLIs_ToGCartQLIs APIClone sales quote line items (QLIs) to working cart QLIs.CloneSalesQuoteToWorkingCart
CloneSalesQToWC_Discounts APIClone sales quote line items (QLIs) to working cart QLIs with discounts and adjustments.CloneSalesQToWCWDiscounts
CloneTo_SalesQLIs APIClone the working cart quote line items (QLIs) to sales QLIs.CloneWorkingCartToSalesQLIs
create_NewGroupAssignMembers APICreate a group and assign members to it in a single call.CreateGroup&AssignMembers
create_WorkingCart APICreate a working cart quote based on a sales quote.CreateWorkingCartQuote
ESM_checkAddressValidation APIValidate the addresses selected with the valid addresses provided by TMF API.ESM_checkAddressValidation
ESM_checkServiceQualification APICheck service qualification for specific locations using TMF API.ESM_checkServiceQualification
ESM_CreateSubOrderForNonMembers APICreate a sub-order for line items without any members or groups using ESM CreateOrder API.ESM_CreateSubOrderForNonMembers
ESM_CustomViewSetup APIStore information about the custom views created for the Summary page.ESM_CustomViewSetup
ESM_DelinkRelatedItemFromCart APIDelink a related quote item (product) from another item of the same quote (from QuoteLineItemRelationship Sobject).ESM_DelinkRelatedItemFromCart
ESM_EvaluateFormula APIEvaluate an expression.ESM_EvaluateFormula
ESM_getCartItemsByView APIRetrieve quote line items for a given quote ID and display option.ESM_getCartItemsByView
ESM_getRelatedProducts APIFetches the related Products QLI from a quote for a particular product relationship.ESM_getRelatedProducts
ESM_LinkProducts APISaves QLI product relationship.ESM_LinkProducts
ESM_UpdateQuoteLineItems APIUpdate a quote line item and its related child items with the given set of fields and values.ESM_UpdateQuoteLineItems
ESM_validateRecords APIValidate quote line items.ESM_validateRecords
getAll_members APIGet all quote members for a given quote ID.GetAllMembers
getAll_QuoteGroup APIGet all custom quote groups for a sales quote.GetAllQGroupForSQ
member_upload APIUpload a CSV file with new subscribers or locations.UploadMembers
QMgetFields_WFieldLabel APIGet the field set with fields and labels for the quote members.QuoteMemberGetFields
Remove_QuoteGroup APIRemove the quote group from the enterprise quote.RemoveQuoteGroup
removeQM_FromQuoteGroup APIRemove a quote member record from the quote group.RemoveQMFromQuoteGroup
UpdateCloneModify_SalesQLIsWQPR APIUpdates, clones, or modifies the quote line items for a given cart ID, group ID, quote member ID, or quote ID.UpdateMemberIdForWC
update_QGroupName APIUpdate the name of the quote group.UpdateQuoteGroupName