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.

POST /v2/cpq/carts/{cart_ID}/items/checkout

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. <!-- Update when the Dev Docs topics migrate.-->

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.

Remote Method

checkout

REST Handler

APICheckoutItemsCartsCPQV2

Apex Remote Service

CpqAppHandler

Apex Remote Input Map

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

{
  methodName:"checkout"
  cartId:801360000008eNU
  ContextId:801360000008eNU
}

Package

Communication (vlocity_cmt)

API Parameters and Response Format

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

Resource Information

Example Request

POST
/v2/cpq/carts/{cart_ID}/items/checkout

Example Responses

note: Submit Opportunity

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

note: Submit Order

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

note: Submit Quote

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