v1

latestOpenAPI 3.0.02026-07-1498671635.3 KB

Order Delivery Webhooks

publicly-accessible

Order requires delivery acceptance

This webhook will be invoked when we have determined that an order is required acceptance for delivery. Upon receiving the request, the order should be scheduled for pickup by a courier/driver. We expect an immediate 201 response from this webhook to denote that you have received the request.

put/order-requires-delivery-acceptance

Request body

CustomerOrderIdnumber

This is a deprecated customer-facing ID that we maintain to support existing implementations.

FriendlyOrderReferencestring

The customer facing identifier for the order, which should be used in any UI or receipts to identify the order to the customer, driver or restaurant. This identifier is not guaranteed to be globally unique.

Idstring

The unique identifier for an order within the country. You can provide this ID whenever sending requests related to the order. Note that further messages from Just Eat relating to this order may not use this same identifier, use OrderId for a more consistent identifier.

IsAMiniFistPumpOrderboolean

Legacy Promotion - Ignore.

OrderIdstring

Globally unique Identifier for the order. Please use this whenever sending requests related to this order. Just Eat will provide this same identifier on any further messages relating to this order.

OrderReferencestring

This field is used to store external references to the order. This is defined by either Just Eat or the partner that created the order.

Example request

[
  {
    "BasketInfo": {
      "BasketId": "ABCb8DzdnUy7G481b0JN5g",
      "DeliveryCharge": 5,
      "Discount": 4.78,
      "Discounts": [
        {
          "Discount": 10,
          "DiscountType": "Percent",
          "Id": 21950,
          "QualifyingValue": 4.78
        }
      ],
      "GroupedBasketItems": [
        {
          "BasketItem": {
            "CombinedPrice": 3.58,
            "Discounts": [
              {
                "Amount": 4.5,
                "DiscountType": "Percent"
              }
            ],
            "MealParts": [
              {
                "GroupId": 1,
                "MealPartId": 45822750,
                "Name": "Any Sides?",
                "OptionalAccessories": [
                  {
                    "Name": "Add Bacon",
                    "OptionalAccessoryId": 56168,
                    "Quantity": 1,
                    "UnitPrice": 0.5
                  }
                ],
                "RequiredAccessories": [
                  {
                    "GroupId": 3,
                    "Name": "Coca-Cola Original Taste",
                    "RequiredAccessoryId": 225025,
                    "UnitPrice": 0.16
                  }
                ]
              }
            ],
            "MenuCardNumber": "1",
            "MultiBuyDiscounts": [
              {
                "Amount": 4.5,
                "DiscountType": "Percent"
              }
            ],
            "Name": "Mini Fillet Burger",
            "OptionalAccessories": [
              {
                "Name": "Add Bacon",
                "OptionalAccessoryId": 56168,
                "Quantity": 1,
                "UnitPrice": 0.5
              }
            ],
            "ProductId": 45858074,
            "ProductTypeId": 428,
            "RequiredAccessories": [
              {
                "GroupId": 3,
                "Name": "Large Meal",
                "RequiredAccessoryId": 225025,
                "UnitPrice": 0.1
              }
            ],
            "UnitPrice": 1.79
          },
          "CombinedPrice": 3.58,
          "MenuCardNumber": "1",
          "Quantity": 2
        }
      ],
      "MenuId": 777890,
      "SubTotal": 47.75,
      "Total": 47.97
    },
    "CustomerInfo": {
      "Address": "Fleet Place House, 2 Fleet Place, London",
      "City": "London",
      "DisplayPhoneNumber": "(01) 872 7863",
      "Email": "contact@just-eat.com",
      "Id": "123456",
      "Latitude": 51.50015,
      "LocationAccuracyDescription": "ROOFTOP",
      "LocationSource": "GeodataGeocoder",
      "Longitude": -0.12624,
      "Name": "Just Eat",
      "PhoneMaskingCode": "444333222",
      "PhoneNumber": "018727863",
      "Postcode": "EC4M 7RF",
      "TimeZone": "GMT Standard Time"
    },
    "CustomerOrderId": 348322088,
    "FriendlyOrderReference": "348322088",
    "Id": "348322088",
    "Order": {
      "NoteToRestaurant": "Contact-free delivery",
      "PickupNoticePeriod": "00:10:00"
    },
    "OrderId": "ijdhpy7bdusgtc28bapspa",
    "OrderReference": "39cce3f0-0278-dd25-ae32-e8effe1ce4eb",
    "PaymentInfo": {
      "PaymentLines": [
        {
          "CardFee": 0.5,
          "Value": 22.05
        }
      ],
      "Total": 22.55
    },
    "RestaurantInfo": {
      "AddressLines": [
        "Fleet Place House 2, Fleet Place, London"
      ],
      "City": "London",
      "DispatchMethod": "Phone",
      "EmailAddress": "contact@testrestaurant.com",
      "Id": "123456",
      "Latitude": 51.50015,
      "Longitude": -0.12624,
      "Name": "Test Restaurant",
      "PhoneNumber": "07123456789",
      "PickupNotes": "Use the back entrance",
      "Postcode": "EC4M 7RF"
    }
  }
]

Response

In the event of successful handling of the request, a 201 status code should be returned, indicating acknowledgement of transmission success.