CartCheckoutSession

Represents a checkout session used in Lightning B2B Commerce checkout.

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

Introduced in API version 47.0.

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

  • This object is available only if the B2B Commerce or D2C Commerce license is enabled.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the in progress background operation.
  • Relationship name: BackgroundOperation
  • Relationship type: relationship
  • Refers to: BackgroundOperation
  • 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.
  • Default value: false
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 49.0
  • Description: Indicates whether the session is in error state (true) or not (false). Default value is false.
  • Default value: false
  • 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.
  • Default value: false
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the checkout session.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The next state of the checkout session.
  • 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.
  • Relationship name: Order
  • Relationship type: relationship
  • Refers to: Order
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The current state of the checkout session.
  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The ID of the cart that is used to create the checkout session.
  • Relationship name: WebCart
  • Relationship type: masterdetail
  • Refers to: WebCart