Get Checkout

{
  "type": "object",
  "description": "Properties apply to all supported country codes, except where specified.",
  "required": [
    "customer",
    "fulfilment",
    "isFulfillable",
    "issues",
    "restaurant",
    "serviceType"
  ],
  "properties": {
    "customer": {
      "type": "object",
      "description": "Details of the customer making the purchase.\n\nDetails of the customer will need to be submitted to the service. No default values will be set.\n",
      "properties": {
        "firstName": {
          "type": "string",
          "description": "Customer's first name. \n\nAlso known as Given Name(s).\n"
        },
        "lastName": {
          "type": "string",
          "description": "Customer's last name (Optional).\n\nAlso known as Family Name.\n"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Customer's phone number.\n\nA phone number can be represented in:\n  - E.164 format e.g. +447777111111 or;\n  - Local format of submitted tenant e.g. 07777111111.\n\nE.164 formatted phone numbers are preferred.\n"
        }
      }
    },
    "fulfilment": {
      "type": "object",
      "description": "How and when the items will be received by the customer.",
      "properties": {
        "location": {
          "type": "object",
          "description": "The destination the customer wants to receive the order.\n\nThis only applies to purchases with a delivery service type.\n",
          "properties": {
            "address": {
              "type": "object",
              "description": "The postal address where the customer wants to receive the order.",
              "properties": {
                "administrativeArea": {
                  "type": "string",
                  "description": "Geographical region of this address. \n\nAlso known as County or State.\n\nRequired in Australia (AU) only for an order to be fulfilled.\n"
                },
                "lines": {
                  "type": "array",
                  "description": "One or more lines representing the street address.",
                  "items": {
                    "type": "string",
                    "description": "Represents part of a street address."
                  }
                },
                "locality": {
                  "type": "string",
                  "description": "The locality of this address.\n\nAlso known as Town or City.\n"
                },
                "postalCode": {
                  "type": "string",
                  "description": "Postal code of this address."
                }
              }
            },
            "geolocation": {
              "type": "object",
              "description": "The coordinates of a geographical location where the customer wants to receive the order.\n\nRequired in Australia (AU) and New Zealand (NZ) only for an order to be fulfilled.\n",
              "required": [
                "latitude",
                "longitude"
              ],
              "properties": {
                "latitude": {
                  "type": "number",
                  "format": "decimal",
                  "description": "The latitude of the geographical location."
                },
                "longitude": {
                  "type": "number",
                  "format": "decimal",
                  "description": "The longitude of the geographical location."
                }
              }
            }
          }
        },
        "time": {
          "type": "object",
          "description": "Time the customer wants to receive the order i.e. when order is fulfilled.",
          "required": [
            "asap"
          ],
          "properties": {
            "asap": {
              "type": "boolean",
              "description": "If the order should be fulfilled as soon as possible (ASAP).\n\nASAP may not be fulfillable.\n\nDefault is false.\n"
            },
            "scheduled": {
              "type": "object",
              "description": "Scheduled time the customer wants the order to be fulfilled.\n\nIf ASAP is selected and fulfillable, this will be set to the next available fulfilment time.\n",
              "required": [
                "from",
                "to"
              ],
              "properties": {
                "from": {
                  "type": "string",
                  "description": "Earliest time the customer wants the order to be fulfilled represented in ISO 8601 UTC (Zulu Time)."
                },
                "to": {
                  "type": "string",
                  "description": "Latest time the customer wants the order to be fulfilled represented in ISO 8601 UTC (Zulu Time). \n\nThis time must be greater than or equal to the from time.\n"
                }
              }
            }
          }
        }
      }
    },
    "isFulfillable": {
      "type": "boolean",
      "description": "Whether the proposed order can be placed."
    },
    "issues": {
      "type": "array",
      "description": "One or more issues associated the proposed order, that may impact whether it can be placed.",
      "items": {
        "type": "object",
        "description": "Represents a single issue associated with the proposed order.",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "The issue code",
            "enum": [
              "RESTAURANT_NOT_TAKING_ORDERS",
              "SERVICE_TYPE_UNAVAILABLE",
              "ITEMS_UNORDERABLE",
              "ADDITIONAL_ITEMS_REQUIRED",
              "MINIMUM_ORDER_VALUE_NOT_MET",
              "FULFILMENT_TIME_UNAVAILABLE",
              "LOCATION_UNDELIVERABLE",
              "AGE_VERIFICATION_FAILED",
              "FIRST_NAME_REQUIRED",
              "PHONE_NUMBER_REQUIRED",
              "DATE_OF_BIRTH_REQUIRED",
              "FULFILMENT_TIME_REQUIRED",
              "ADDRESS_LINES_REQUIRED",
              "LOCALITY_REQUIRED",
              "ADMINISTRATIVE_AREA_REQUIRED",
              "POSTAL_CODE_REQUIRED",
              "GEOLOCATION_REQUIRED"
            ]
          }
        }
      }
    },
    "restaurant": {
      "type": "object",
      "description": "The restaurant selling the items to be purchased.",
      "required": [
        "availabilityId",
        "id"
      ],
      "properties": {
        "availabilityId": {
          "type": "string",
          "description": "Unique identifier to identify when item(s) are available for ordering.\n"
        },
        "id": {
          "type": "string",
          "description": "Unique identifier for the restaurant."
        }
      }
    },
    "serviceType": {
      "type": "string",
      "description": "How the order will be dispatched.",
      "enum": [
        "delivery",
        "collection"
      ]
    }
  }
}