Order ready for preparation (async)

v1.0.0

This webhook will be invoked when we have determined that an order is ready for preparation. Upon receiving the request, you should perform any preparation-related activities, such as sending the order to the POS system / kitchen screen. NOTE: This version of the webhook is asynchronous, and we expect a response in two parts:

We expect an immediate 202 response from this webhook to denote that you have received the request;
Following that, we expect an - indicating either success or failure of the operation. The body for the async callbacks are as below:

Success callback

Failure callback

Input

{
  "type": "object",
  "properties": {
    "Currency": {
      "type": "string"
    },
    "Customer": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        }
      }
    },
    "CustomerNotes": {
      "type": "object"
    },
    "Fulfilment": {
      "type": "object",
      "properties": {
        "Address": {
          "type": "object",
          "properties": {
            "City": {
              "type": "string"
            },
            "Geolocation": {
              "type": "object",
              "description": "GeoLocation object containing latitude and longitude values.",
              "required": [
                "Latitude",
                "Longitude"
              ],
              "properties": {
                "Accuracy": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the accuracy of driver's location."
                },
                "Heading": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the degree of heading direction, for example, 0 is north, 90 is east."
                },
                "Latitude": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the latitude of the driver's location."
                },
                "Longitude": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the longitude of the driver's location."
                },
                "Speed": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the travel speed of the driver."
                }
              }
            },
            "Lines": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "PostalCode": {
              "type": "string"
            }
          }
        },
        "CustomerDueAsap": {
          "type": "boolean"
        },
        "CustomerDueDate": {
          "type": "string",
          "format": "date-time"
        },
        "Method": {
          "type": "string",
          "enum": [
            "Delivery",
            "Collection"
          ]
        },
        "PhoneNumber": {
          "type": "string"
        },
        "PreparationTime": {
          "type": "string",
          "format": "timespan"
        },
        "PrepareFor": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "IsTest": {
      "type": "boolean"
    },
    "Items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Items": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "Name": {
            "type": "string"
          },
          "Quantity": {
            "type": "integer"
          },
          "Reference": {
            "type": "string"
          },
          "UnitPrice": {
            "type": "integer",
            "format": "money"
          }
        }
      }
    },
    "OrderId": {
      "type": "string"
    },
    "Payment": {
      "type": "object",
      "properties": {
        "Lines": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Paid": {
                "type": "boolean"
              },
              "Type": {
                "type": "string",
                "enum": [
                  "card",
                  "cash",
                  "credit",
                  "other"
                ]
              },
              "Value": {
                "type": "number",
                "format": "money"
              }
            }
          }
        }
      }
    },
    "PlacedDate": {
      "type": "string",
      "format": "date-time"
    },
    "PriceBreakdown": {
      "type": "object",
      "properties": {
        "Discount": {
          "type": "number",
          "format": "money"
        },
        "Fees": {
          "type": "object",
          "properties": {
            "Delivery": {
              "type": "number",
              "format": "money"
            },
            "Other": {
              "type": "number",
              "format": "money"
            },
            "ServiceCharge": {
              "type": "number",
              "format": "money"
            }
          }
        },
        "Items": {
          "type": "number",
          "format": "money"
        },
        "Taxes": {
          "type": "number",
          "format": "money"
        },
        "Tips": {
          "type": "number",
          "format": "money"
        }
      }
    },
    "Restaurant": {
      "type": "object",
      "properties": {
        "Address": {
          "type": "object",
          "properties": {
            "City": {
              "type": "string"
            },
            "Geolocation": {
              "type": "object",
              "description": "GeoLocation object containing latitude and longitude values.",
              "required": [
                "Latitude",
                "Longitude"
              ],
              "properties": {
                "Accuracy": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the accuracy of driver's location."
                },
                "Heading": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the degree of heading direction, for example, 0 is north, 90 is east."
                },
                "Latitude": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the latitude of the driver's location."
                },
                "Longitude": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the longitude of the driver's location."
                },
                "Speed": {
                  "type": "number",
                  "format": "double",
                  "description": "This should represent the travel speed of the driver."
                }
              }
            },
            "Lines": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "PostalCode": {
              "type": "string"
            }
          }
        },
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "PhoneNumber": {
          "type": "string"
        },
        "Reference": {
          "type": "string"
        }
      }
    },
    "TotalPrice": {
      "type": "number",
      "format": "money"
    }
  }
}

Output

{
  "type": "object",
  "additionalProperties": true
}