v1

latestOpenAPI 3.0.02026-07-1498671635.3 KB
Checkout
publicly-accessible

Get Checkout

Get the details required to fulfil an order, which includes:

  • The restaurant selling the items to be purchased
  • The customer making the purchase
  • How, where and when the items will be received by the customer
  • Instructions about the order
get/checkout/{tenant}/{checkoutId}

Path parameters

tenantstring required

A two-character country code.

The following countries are supported:

  • United Kingdom (UK)
  • Australia (AU)
  • New Zealand (NZ)
checkoutIdstring required

A unique identifier for a checkout. This is currently a Basket Id.

Headers

User-Agentstring required

Allows the server to identify the application making the request.

Response

OK : Request has succeeded.

isFulfillableboolean required

Whether the proposed order can be placed.

serviceType'delivery' | 'collection' required

How the order will be dispatched.