Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

CartCheckoutSession

Represents a checkout session used in Lightning B2B Commerce checkout. This object is available in API version 48.0 and later.

A checkout session is tied to a single web cart, but there can be multiple checkout sessions for a single cart.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

This object is available only if the B2B Commerce or D2C Commerce license is enabled.

Fields

Field	Details
BackgroundOperationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the in progress background operation.
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The currency used for the checkout session. Default value is `USD`. Possible values are: `USD`—U.S. Dollar
IsArchived	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether checkout processing is archived (`true`) or not (`false`). After a session is archived, it can’t be unarchived. Default value is `false`.
IsError	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the session is in error state (`true`) or not (`false`). Default value is `false`.
IsProcessing	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Determines whether checkout processing is in progress (`true`) or not (`false`). Default value is `false`.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the checkout session.
NextState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The next state of the checkout session.
OrderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a created order after the checkout session has gone from cart to order.
OrderReferenceNumber	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Unique reference number the shopper can use to refer to the order. In API version 63.0 and later, LWR stores don't populate this field upon checkout. Instead, the `InitialOrderReferenceNumber` field on the WebCart object is populated.
State	Type string Properties Create, Filter, Group, Sort, Update Description The current state of the checkout session.
WebCartId	Type reference Properties Create, Filter, Group, Sort Description The ID of the cart that is used to create the checkout session.

Object Reference for the Salesforce Platform

CartCheckoutSession

Supported Calls

Special Access Rules

Fields