v1

latestOpenAPI 3.0.02026-07-1498671635.3 KB
Order Webhooks
publicly-accessible

Order ready for preparation (sync)

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.

post/order-ready-for-preparation-sync

Request body

Currencystring
CustomerNotesobject
IsTestboolean
OrderIdstring
PlacedDatestring date-time
TotalPricenumber

Example request

{
  "Currency": "GBP",
  "Customer": {
    "Id": "Batman",
    "Name": "Bruce Wayne"
  },
  "CustomerNotes": [
    {
      "Key": "Floor",
      "Value": "5th floor"
    },
    {
      "Key": "Code",
      "Value": "Code 1234"
    }
  ],
  "Fulfilment": {
    "Address": {
      "City": "London",
      "Geolocation": {
        "Latitude": 51.51641,
        "Longitude": -0.103198
      },
      "Lines": [
        "Fleet Place House",
        "Fleet Pl"
      ],
      "PostalCode": "EC4M 7RD"
    },
    "CustomerDueAsap": false,
    "CustomerDueDate": "2018-03-10T14:45:28Z",
    "Method": "Delivery",
    "PhoneNumber": "+441234567890"
  },
  "IsTest": true,
  "Items": [
    {
      "Items": [
        {
          "Items": [],
          "Name": "Fries",
          "Quantity": 1,
          "Reference": "9876",
          "Synonym": "Regular",
          "UnitPrice": 0
        },
        {
          "Items": [],
          "Name": "Pepsi",
          "Quantity": 2,
          "Reference": "6789",
          "Synonym": "330ml",
          "UnitPrice": 0
        }
      ],
      "Name": "Chicken Box Meal",
      "Quantity": 2,
      "Reference": "1234",
      "Synonym": "",
      "TotalPrice": 10,
      "UnitPrice": 5
    },
    {
      "Items": [],
      "Name": "Milkshake",
      "Quantity": 1,
      "Reference": "4321",
      "Synonym": "",
      "TotalPrice": 7.25,
      "UnitPrice": 7.25
    }
  ],
  "OrderId": "XYZ123456",
  "Payment": {
    "Lines": [
      {
        "Paid": false,
        "Type": "card",
        "Value": 19.25
      }
    ]
  },
  "PlacedDate": "2018-03-10T14:45:28Z",
  "PriceBreakdown": {
    "Discount": 0,
    "Fees": {
      "Delivery": 1,
      "Other": 0,
      "ServiceCharge": 0.5
    },
    "Items": 17.25,
    "Taxes": 3.85,
    "Tips": 0.5
  },
  "Restaurant": {
    "Address": {
      "City": "London",
      "Geolocation": {
        "Latitude": 51.4484,
        "Longitude": -0.1504
      },
      "Lines": [
        "Oldridge Road"
      ],
      "PostalCode": "SW12 8PW"
    },
    "Id": "99999",
    "Name": "Just Eat Test Restaurant",
    "PhoneNumber": "+441200000000",
    "Refererence": "R99999"
  },
  "TotalPrice": 19.25
}

Response

Respond with a 200 status code to indicate that you have received the notification.