Newer Version Available

This content describes an older version of this product. View Latest

Checkout

Checkout for a Commerce store.
JSON examples

Here’s an example for POST.

Here’s an example for PUT when delivery methods and delivery groups are present.

Property Name Type Description Filter Group and Version Available Version
cart​Summary Cart Summary Information Summary details of a cart. Small, 61.0 61.0
checkout​Id String ID for the checkout. Small, 55.0 55.0
contact​Info Contact Info Information for a guest contact. Small, 55.0 55.0
custom​Fields SObject[]

Array of sObjects and viewable custom fields for the sObjects. Currently, only the WebCart and CartDeliveryGroup sObjects are supported. The custom fields can be of type Checkbox, Currency, Date, Email, LongTextArea, Number, Percent, Phone, Text, TextArea, or Url.

The supported format for dateTime fields is yyyy-MM-​ddTHH:mm:ss.SSSZ.

The supported format for time fields is HH:mm.ss.SSSZ.

The customFields property isn't supported in stores built on an Aura template.

Small, 62.0 62.0
delivery​Groups Delivery Group Collection Available delivery group for checkout. Big, 55.0 55.0
errors Checkout Error[] List of errors, if any, for the checkout. Small, 55.0 55.0
orderReference​Number String Globally unique identifier (GUID) of the payment order generated after successful completion of a payment request. Small, 61.0 61.0
status​Code String HTTP response code for the request. Small, 57.0 57.0