Checkout Items in a Cart

Overview

The Checkout API finalizes a CPQ cart by performing all mandatory validations, pricing recalculations, asset‑generation steps and transaction commits required to create a ready‑to‑bill Order. <br> It is the logical culmination of the add → configure → price → validate → checkout pattern common to digital‑commerce and assisted‑selling flows.

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.

Odin Bifurcation

The call path depends on the OdinAPIHandler interface chosen at runtime:

• OdinAPIAutoAssetizeHandler – routes directly to Java core classes (CheckoutAction, CheckoutServiceImpl) for high‑volume assetisation use‑cases.
• Any other implementation – executes entirely in Apex inside the managed package, allowing org‑specific extensions before/after core logic.

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

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.

Rest Handler

APICheckoutItemsCartsCPQV2

Rest Method

checkoutItems

Remote Service

CpqAppHandler

Remote Method

checkout

Apex Remote Input Map

Map<String, Object> inputMap = new Map<String, Object>{
    'cartId' => '{CART_ID}'
};
Map<String, Object> outputMap = new Map<String, Object>();
Map<String, Object> optionsMap = new Map<String, Object>();
CpqAppHandler handler = new CpqAppHandler();
handler.invokeMethod('checkout', inputMap, outputMap, optionsMap);

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

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

{
   "validate": true,
   "assetizeFullBundlePerRoot": false,
   "validateSubmittedXLI": false
}

Example Responses

{
  "totalSize": 1,
  "messages": [
    {
      "code": "SUBMIT-1008",
      "severity": "INFO",
      "message": "Order 801xx000003H0JTAA0 was assetized and activated."
    }
  ],
  "records": [
    {
      "messages": [

      ],
      "displaySequence": -1,
      "clonedObjectIds": "["02ixx0000004N2AAAU"]",
      "id": "001xx000003H0HrAAK",
      "objectType": "Account"
    }
  ]
}

note: 'objectType' conveys the type of the object that was created by the Checkout process.<br> For Eg: If Checkout is performed from an Opportunity, the objectType will be Quote.