The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Checkout Items in Cart

Based on the header object, submit the object to create the quote, order, or assets.

  • If the header object is Opportunity, submit the opportunity to create a quote.

  • If the header object is Quote, submit the quote to create an order.

  • If the header object is Order, submit the order to create assets.

These APIs replace the following methods in OmniCPQServiceWrapper:

  • Submit Opportunity replaces OmniCPQServceWrapper submitOpportunity.

  • Submit Order replaces OmniCPQServiceWrapper submitOrder.

  • Submit Quote replaces OmniCPQServiceWrapper submitQuote.

For more information, see OmniCPQServiceWrapper.

This API supports the guest user enhancements that Salesforce introduced with the Winter ‘21 release. To encrypt and decrypt data for guest users, use the UserSecurity class with this API. See Guest User Technical Details.

For additional information, ​see UserSecurity Class and CPQ and Digital Commerce Changes for Guest Users.

ContextId is required for the Checkout Items in Cart remote action, which is used in the Guided Selling OmniScript.

Communication (vlocity_cmt)

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

Response FormatJSON
Resource URL/services/apexrest/namespace/v2/cpq/carts/{cart_ID}/items/checkout

Submit Opportunity

{
   "totalSize":1,
   "messages":[],
   "records":
   [
      {
         "messages":[],
         "displaySequence":-1,
         "id":"0Q01I000000TvNmSAK",
         "objectType":"Quote"
      }
   ]
}

Submit Order

"records": [
{
   "messages": [],
   "displaySequence": -1,
   "id": "00146000004DeR9AAK",
   "objectType": "Account"
}
]

Submit Quote

{
   "totalSize":1,
   "messages":[],
   "records":
   [
      {
         "messages":[],
         "displaySequence":-1,
         "id":"8011I000000KZW3QAO",
         "objectType":"Order"
      }
   ]
}