Connect REST API Developer Guide
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
Newer Version Available
Checkout
- 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 |
|---|---|---|---|---|
| cartSummary | Cart Summary Information | Summary details of a cart. | Small, 61.0 | 61.0 |
| checkoutId | String | ID for the checkout. | Small, 55.0 | 55.0 |
| contactInfo | Contact Info | Information for a guest contact. | Small, 55.0 | 55.0 |
| customFields | 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 |
| deliveryGroups | 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 |
| orderReferenceNumber | String | Globally unique identifier (GUID) of the payment order generated after successful completion of a payment request. | Small, 61.0 | 61.0 |
| statusCode | String | HTTP response code for the request. | Small, 57.0 | 57.0 |