POST API/V40/Interactive/Cart/Checkout

Cart check Out

Request Information

URI Parameters

None.

Body Parameters

The request model.

Name	Description	Type	Additional information
Pin	Not yet implemeted - validates against the guests's chosen pin number	string
Comment		string
NumberOfGuests		integer
DeliveryDateTime		date
IsDeliveryDateTimeUtc	Immediate requests can only pass UTC time, as we don't know 100% where the request is coming from Requests for later can only pass local time - guests can't be expected to make the conversion to UTC!	boolean
Total	If not null, this is validated in the checkout against the server-generated total for the cart. If null or absent, no such validation is attempted - to maintain backwards compatibility	decimal number
SessionToken	The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "pin": "sample string 1",
  "comment": "sample string 2",
  "numberOfGuests": 1,
  "deliveryDateTime": "2024-11-06T08:38:08.9481145+00:00",
  "isDeliveryDateTimeUtc": true,
  "total": 1.0,
  "sessionToken": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
SessionToken	The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller.	string
ResponsesIncluded	A list of response messages names contained in this composite message, for easy pre-parsing.	string
Responses	A list of response messages contained in this composite message.	Collection of Object CheckoutResponse
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "uUOEVz7-3IgKAAAAAAAAAAAAAAA.1i8Eeha3I9tBYGNNozNGGgr3XiD0jl6SSYcCsqfPToc",
  "responsesIncluded": "responseStatus",
  "responses": [
    {
      "responseStatus": {
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}