v1

latestOpenAPI 3.0.02026-07-1498671635.3 KB
Restaurants
publicly-accessible

Create or update a menu

This will begin an asynchronous process that will lead to that menu becoming live on the Just Eat platform

put/restaurants/{tenant}/{restaurantId}/menu

Path parameters

tenantstring required

The tenant of the restaurant in which to put a menu

restaurantIdstring required

The restaurant identifier to associated with the menu

Headers

Authorizationstring required

Containing a partner issued API key e.g. JE-API-KEY ABCDE123456789

Content-Typestring

Used to denote the version of the menu payload within the body, will default to latest if not supplied e.g. application/=1.0

Request body

currencystring

The currency of the items on the menu in ISO 4217 format, i.e. GBP, EUR or AUD

descriptionstring

A top level description for the menu.

namestring

The name of the restaurant.

restaurantIdstring

A unique identifier at tenant level for a given restaurant.

Example request

{
  "categories": [
    {
      "description": "",
      "id": "3",
      "itemIds": [
        "65143901"
      ],
      "name": "Starters"
    },
    {
      "description": "",
      "id": "4",
      "itemIds": [
        "23435309",
        "33445308"
      ],
      "name": "Deals"
    },
    {
      "description": "",
      "id": "5",
      "itemIds": [
        "8547130",
        "8547140"
      ],
      "name": "Pizzas"
    },
    {
      "description": "",
      "id": "6",
      "itemIds": [
        "6537130",
        "6537140"
      ],
      "name": "Drinks"
    }
  ],
  "currency": "GBP",
  "description": "My excellent menu",
  "items": [
    {
      "dealGroups": [
        {
          "dealItemVariations": [
            {
              "additionPrice": 0,
              "dealItemVariationId": "1577341",
              "maxChoices": 1,
              "minChoices": 0
            }
          ],
          "id": "23435309-1",
          "name": "Choose your base",
          "numberOfChoices": 1
        },
        {
          "dealItemVariations": [
            {
              "additionPrice": 0,
              "dealItemVariationId": "8547121",
              "maxChoices": 1,
              "minChoices": 0
            },
            {
              "additionPrice": 0,
              "dealItemVariationId": "3547157",
              "maxChoices": 1,
              "minChoices": 0
            },
            {
              "additionPrice": 50,
              "dealItemVariationId": "8548153",
              "maxChoices": 1,
              "minChoices": 0
            }
          ],
          "id": "23435309-2",
          "name": "Choose your halves",
          "numberOfChoices": 2
        }
      ],
      "description": "Choose each half.",
      "id": "23435309",
      "labels": [],
      "modifierGroups": [],
      "name": "Half-and-half Pizza",
      "type": "deal",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery"
          ],
          "basePrice": 3099,
          "dealGroupsIds": [
            "23435309-1",
            "23435309-2"
          ],
          "dealOnly": false,
          "id": "23435309",
          "modifierGroupsIds": [],
          "name": "",
          "type": "noVariation"
        }
      ]
    },
    {
      "dealGroups": [
        {
          "dealItemVariations": [
            {
              "additionPrice": 0,
              "dealItemVariationId": "9750011",
              "maxChoices": 1,
              "minChoices": 0
            },
            {
              "additionPrice": 0,
              "dealItemVariationId": "9750021",
              "maxChoices": 1,
              "minChoices": 0
            },
            {
              "additionPrice": 0,
              "dealItemVariationId": "23435309",
              "maxChoices": 1,
              "minChoices": 0
            }
          ],
          "id": "33445308-1",
          "name": "Choose your pizza",
          "numberOfChoices": 1
        },
        {
          "dealItemVariations": [
            {
              "additionPrice": 13,
              "dealItemVariationId": "6537130",
              "maxChoices": 1,
              "minChoices": 0
            },
            {
              "additionPrice": 0,
              "dealItemVariationId": "6537140",
              "maxChoices": 1,
              "minChoices": 0
            },
            {
              "additionPrice": 0,
              "dealItemVariationId": "7739164",
              "maxChoices": 1,
              "minChoices": 0
            }
          ],
          "id": "33445308-2",
          "name": "Choose your drink",
          "numberOfChoices": 1
        }
      ],
      "description": "Choose a 14 inch Pizza (including half-and-half) and any drink. Note: Alcohol is only available for collection.",
      "id": "33445308",
      "labels": [],
      "modifierGroups": [],
      "name": "14 inch Pizza & A Drink For 1",
      "type": "deal",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery"
          ],
          "basePrice": 3099,
          "dealGroupsIds": [
            "33445308-1",
            "33445308-2"
          ],
          "dealOnly": false,
          "id": "33445308",
          "modifierGroupsIds": [],
          "name": "",
          "type": "noVariation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "65143901",
      "labels": [],
      "modifierGroups": [
        {
          "id": "65143901-req-1",
          "maxChoices": 1,
          "minChoices": 1,
          "modifiers": [
            {
              "additionPrice": 0,
              "id": "834502",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Pitta Bread"
            },
            {
              "additionPrice": 0,
              "id": "835700",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Sourdough"
            },
            {
              "additionPrice": 50,
              "id": "835601",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Wholemeal"
            }
          ],
          "name": "Choose your bread"
        },
        {
          "id": "65143901-req-2",
          "maxChoices": 2,
          "minChoices": 2,
          "modifiers": [
            {
              "additionPrice": 0,
              "id": "835340",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Tzatziki"
            },
            {
              "additionPrice": 0,
              "id": "835341",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Taramasalata"
            },
            {
              "additionPrice": 0,
              "id": "825344",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Hummus"
            },
            {
              "additionPrice": 0,
              "id": "825346",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Onion"
            }
          ],
          "name": "Choose your dips"
        }
      ],
      "name": "Flat Bread and Dips (Pick any 2 Dips)",
      "requireOtherProducts": false,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 650,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "65143901",
          "kitchenNumber": "90",
          "modifierGroupsIds": [
            "65143901-req-1",
            "65143901-req-2"
          ],
          "name": "",
          "type": "noVariation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "1577341",
      "labels": [],
      "modifierGroups": [
        {
          "id": "1577341-req-1",
          "maxChoices": 1,
          "minChoices": 1,
          "modifiers": [
            {
              "additionPrice": 0,
              "id": "854500",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Classic Crust"
            },
            {
              "additionPrice": 200,
              "id": "854600",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Stuffed Crust"
            }
          ],
          "name": "Crust"
        }
      ],
      "name": "Base",
      "requireOtherProducts": true,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 200,
          "dealGroupsIds": [],
          "dealOnly": true,
          "id": "1577341",
          "modifierGroupsIds": [
            "1577341-req-1"
          ],
          "name": "",
          "type": "noVariation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "8547130",
      "labels": [],
      "modifierGroups": [
        {
          "id": "8547130-req-1",
          "maxChoices": 1,
          "minChoices": 1,
          "modifiers": [
            {
              "additionPrice": 0,
              "id": "854500",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Classic Crust"
            },
            {
              "additionPrice": 200,
              "id": "854600",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Stuffed Crust"
            }
          ],
          "name": "Choose your crust"
        },
        {
          "id": "8547130-opt-1",
          "maxChoices": 10,
          "minChoices": 0,
          "modifiers": [
            {
              "additionPrice": 50,
              "id": "1000",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Mozzarella Cheese"
            },
            {
              "additionPrice": 50,
              "id": "1001",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Ham"
            },
            {
              "additionPrice": 50,
              "id": "1002",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Red Onion"
            },
            {
              "additionPrice": 50,
              "id": "1003",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Pepperoni"
            },
            {
              "additionPrice": 50,
              "id": "1004",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Olives"
            }
          ],
          "name": "Any extra toppings?"
        }
      ],
      "name": "Margherita",
      "requireOtherProducts": true,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 500,
          "dealGroupsIds": [],
          "dealOnly": true,
          "id": "8547121",
          "kitchenNumber": "100",
          "modifierGroupsIds": [
            "8547130-opt-1"
          ],
          "name": "Half",
          "type": "variation"
        },
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 1000,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "8547130",
          "kitchenNumber": "100",
          "modifierGroupsIds": [
            "8547130-req-1",
            "8547130-opt-1"
          ],
          "name": "12 inch",
          "type": "variation"
        },
        {
          "availabilityIds": [
            "1-lunch-delivery-weekday",
            "2-lunch-collection-weekday",
            "3-dinner-delivery-weekday",
            "4-dinner-collection-weekday"
          ],
          "basePrice": 1200,
          "dealGroupsIds": [],
          "dealOnly": true,
          "id": "8543123",
          "kitchenNumber": "200",
          "modifierGroupsIds": [
            "8547130-req-1",
            "8547130-opt-1"
          ],
          "name": "14 inch",
          "type": "variation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "8547140",
      "labels": [],
      "modifierGroups": [
        {
          "id": "8547140-req-1",
          "maxChoices": 1,
          "minChoices": 1,
          "modifiers": [
            {
              "additionPrice": 0,
              "id": "854500",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Classic Crust"
            },
            {
              "additionPrice": 200,
              "id": "854600",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Stuffed Crust"
            }
          ],
          "name": "Choose your crust"
        },
        {
          "id": "8547140-opt-1",
          "maxChoices": 10,
          "minChoices": 0,
          "modifiers": [
            {
              "additionPrice": 50,
              "id": "1000",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Mozzarella Cheese"
            },
            {
              "additionPrice": 50,
              "id": "1001",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Ham"
            },
            {
              "additionPrice": 50,
              "id": "1002",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Red Onion"
            },
            {
              "additionPrice": 50,
              "id": "1003",
              "maxChoices": 4,
              "minChoices": 2,
              "name": "Pepperoni"
            },
            {
              "additionPrice": 50,
              "id": "1004",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Olives"
            }
          ],
          "name": "Any extra toppings?"
        },
        {
          "id": "9755052-req-1",
          "maxChoices": 1,
          "minChoices": 1,
          "modifiers": [
            {
              "additionPrice": 0,
              "id": "854500",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Classic Crust"
            },
            {
              "additionPrice": 250,
              "id": "854600",
              "maxChoices": 1,
              "minChoices": 0,
              "name": "Stuffed Crust"
            }
          ],
          "name": "Choose your crust"
        },
        {
          "id": "9755052-opt-1",
          "maxChoices": 10,
          "minChoices": 0,
          "modifiers": [
            {
              "additionPrice": 70,
              "id": "1000",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Mozzarella Cheese"
            },
            {
              "additionPrice": 70,
              "id": "1001",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Ham"
            },
            {
              "additionPrice": 70,
              "id": "1002",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Red Onion"
            },
            {
              "additionPrice": 70,
              "id": "1003",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Pepperoni"
            },
            {
              "additionPrice": 70,
              "id": "1004",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Olives"
            }
          ],
          "name": "Any extra toppings?"
        }
      ],
      "name": "Double Pepperoni",
      "requireOtherProducts": false,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 500,
          "dealGroupsIds": [],
          "dealOnly": true,
          "id": "8548153",
          "kitchenNumber": "100",
          "modifierGroupsIds": [
            "8547140-opt-1"
          ],
          "name": "Half",
          "type": "variation"
        },
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 1000,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "8547140",
          "kitchenNumber": "100",
          "modifierGroupsIds": [
            "8547140-req-1",
            "8547140-opt-1"
          ],
          "name": "12 inch",
          "type": "variation"
        },
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 1200,
          "dealGroupsIds": [],
          "dealOnly": true,
          "id": "9750021",
          "kitchenNumber": "200",
          "modifierGroupsIds": [
            "8547140-req-1",
            "8547140-opt-1"
          ],
          "name": "14 inch",
          "type": "variation"
        },
        {
          "availabilityIds": [
            "2-lunch-collection",
            "4-dinner-collection"
          ],
          "basePrice": 1200,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "9755052",
          "kitchenNumber": "200",
          "modifierGroupsIds": [
            "9755052-req-1",
            "9755052-opt-1"
          ],
          "name": "18 inch",
          "type": "variation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "3547157",
      "labels": [
        "vegetarian"
      ],
      "modifierGroups": [
        {
          "id": "8547140-opt-1",
          "maxChoices": 10,
          "minChoices": 0,
          "modifiers": [
            {
              "additionPrice": 50,
              "id": "1000",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Mozzarella Cheese"
            },
            {
              "additionPrice": 50,
              "id": "1001",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Ham"
            },
            {
              "additionPrice": 50,
              "id": "1002",
              "maxChoices": 2,
              "minChoices": 1,
              "name": "Red Onion"
            },
            {
              "additionPrice": 50,
              "id": "1003",
              "maxChoices": 2,
              "minChoices": 0,
              "name": "Pepperoni"
            },
            {
              "additionPrice": 50,
              "id": "1004",
              "maxChoices": 2,
              "minChoices": 1,
              "name": "Olives"
            }
          ],
          "name": "Any extra toppings?"
        }
      ],
      "name": "Vegetarian",
      "requireOtherProducts": false,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 500,
          "dealGroupsIds": [],
          "dealOnly": true,
          "id": "3547157",
          "kitchenNumber": "121",
          "modifierGroupsIds": [
            "8547140-opt-1"
          ],
          "name": "",
          "type": "noVariation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "6537130",
      "labels": [],
      "modifierGroups": [],
      "name": "Coca-Cola",
      "requireOtherProducts": true,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 100,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "6537130",
          "kitchenNumber": "300",
          "modifierGroupsIds": [],
          "name": "0.33L",
          "type": "variation"
        },
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 300,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "9750011",
          "kitchenNumber": "400",
          "modifierGroupsIds": [],
          "name": "1.5L",
          "type": "variation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "6537140",
      "labels": [],
      "modifierGroups": [],
      "name": "Diet Coke",
      "requireOtherProducts": true,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 100,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "6537140",
          "kitchenNumber": "300",
          "modifierGroupsIds": [],
          "name": "0.33L",
          "type": "variation"
        },
        {
          "availabilityIds": [
            "1-lunch-delivery",
            "2-lunch-collection",
            "3-dinner-delivery",
            "4-dinner-collection"
          ],
          "basePrice": 300,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "9750312",
          "kitchenNumber": "400",
          "modifierGroupsIds": [],
          "name": "1.5L",
          "type": "variation"
        }
      ]
    },
    {
      "dealGroups": [],
      "description": "",
      "id": "7739164",
      "labels": [],
      "modifierGroups": [],
      "name": "Bottle of Lager",
      "requireOtherProducts": true,
      "type": "menuItem",
      "variations": [
        {
          "availabilityIds": [
            "2-lunch-collection",
            "4-dinner-collection"
          ],
          "basePrice": 300,
          "dealGroupsIds": [],
          "dealOnly": false,
          "id": "7739164",
          "kitchenNumber": "700",
          "modifierGroupsIds": [],
          "name": "",
          "type": "noVariation"
        }
      ]
    }
  ],
  "name": "My Restaurant",
  "restaurantId": "100059"
}

Response

Accepted

correlationIdstring

An ID for the asynchronous operation to ingest the menu

Example response

{
  "correlationId": "64bef5ee-7265-47f8-9aee-28bc74f00b13"
}