Menu Create or Update

Request

Authorization

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Header Params

X-Merchant-ID

string

required

Your designated merchant ID (Request this from Atlas)

Example:

atlas-merchant-id-1

Body Params application/json

string

required

Contains the readable identifier set in the Atlas Merchant Portal

brand_id

integer

required

Contains the ID of the brand this menu belongs to

start_date

string

required

Start date for when the menu will be available to diners. Format: YYYY-MM-DD

end_date

string

required

End date for when the menu will be available to diners. Format: YYYY-MM-DD

label

string

required

Name of the menu

sections

array[object (SectionPayload) {3}]

optional

Contains the list of sections under the menu, sorted in ascending order by display_order

string

required

Contains the readable identifier set in the Atlas Merchant Portal

name

string

required

Name of the section

products

array[object (ProductPayload) {5}]

optional

Contains products under this section

Example

{
  "id": "configurable-item-menu",
  "label": "Configurable Item Menu",
  "start_date": "2025-07-10",
  "end_date": "2035-07-10",
  "brand_id": 1,
  "sections": [
    {
      "id": "burgers",
      "name": "Burgers",
      "products": [
        {
          "id": "custom-burger",
          "name": "Custom Burger",
          "price": 12.0,
          "modifier_groups": [
            {
              "id": "burger-patty",
              "name": "Choose Your Patty",
              "min_selections": 1,
              "max_selections": 1,
              "modifiers": [
                {
                  "id": "beef-patty",
                  "name": "Beef Patty",
                  "price": 0.0,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-beef-patty",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                },
                {
                  "id": "chicken-patty",
                  "name": "Chicken Patty",
                  "price": 1.0,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-chicken-patty",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                }
              ]
            },
            {
              "id": "burger-toppings",
              "name": "Add Toppings",
              "min_selections": 0,
              "max_selections": 2,
              "modifiers": [
                {
                  "id": "lettuce",
                  "name": "Lettuce",
                  "price": 0.50,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-lettuce",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                },
                {
                  "id": "tomato",
                  "name": "Tomato",
                  "price": 0.50,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-tomato",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                }
              ]
            }
          ],
          "external_item_links": [
            {
              "external_item_link_id": "ext-custom-burger",
              "external_item_link_type": "deliveroo",
              "outlet_id": 1
            },
            {
              "external_item_link_id": "abc123",
              "external_item_link_type": "UberEats",
              "outlet_id": 7
            }
          ]
        },
        {
          "id": "veggie-burger",
          "name": "Veggie Burger",
          "price": 9.99
        }
      ]
    },
    {
      "id": "drinks",
      "name": "Drinks",
      "products": [
        {
          "id": "coke",
          "name": "Coke",
          "price": 2.5,
          "external_item_links": [
            {
              "external_item_link_id": "def456",
              "external_item_link_type": "deliveroo",
              "outlet_id": 1
            },
            {
              "external_item_link_id": "ghi789",
              "external_item_link_type": "UberEats",
              "outlet_id": 7
            }
          ]
        }
      ]
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.atlas.kitchen/admin/v1/menus' \
--header 'X-Merchant-ID: atlas-merchant-id-1' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key;' \
--data-raw '{
  "id": "configurable-item-menu",
  "label": "Configurable Item Menu",
  "start_date": "2025-07-10",
  "end_date": "2035-07-10",
  "brand_id": 1,
  "sections": [
    {
      "id": "burgers",
      "name": "Burgers",
      "products": [
        {
          "id": "custom-burger",
          "name": "Custom Burger",
          "price": 12.0,
          "modifier_groups": [
            {
              "id": "burger-patty",
              "name": "Choose Your Patty",
              "min_selections": 1,
              "max_selections": 1,
              "modifiers": [
                {
                  "id": "beef-patty",
                  "name": "Beef Patty",
                  "price": 0.0,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-beef-patty",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                },
                {
                  "id": "chicken-patty",
                  "name": "Chicken Patty",
                  "price": 1.0,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-chicken-patty",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                }
              ]
            },
            {
              "id": "burger-toppings",
              "name": "Add Toppings",
              "min_selections": 0,
              "max_selections": 2,
              "modifiers": [
                {
                  "id": "lettuce",
                  "name": "Lettuce",
                  "price": 0.50,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-lettuce",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                },
                {
                  "id": "tomato",
                  "name": "Tomato",
                  "price": 0.50,
                  "external_item_links": [
                    {
                      "external_item_link_id": "ext-tomato",
                      "external_item_link_type": "deliveroo",
                      "outlet_id": 1
                    }
                  ]
                }
              ]
            }
          ],
          "external_item_links": [
            {
              "external_item_link_id": "ext-custom-burger",
              "external_item_link_type": "deliveroo",
              "outlet_id": 1
            },
            {
              "external_item_link_id": "abc123",
              "external_item_link_type": "UberEats",
              "outlet_id": 7
            }
          ]
        },
        {
          "id": "veggie-burger",
          "name": "Veggie Burger",
          "price": 9.99
        }
      ]
    },
    {
      "id": "drinks",
      "name": "Drinks",
      "products": [
        {
          "id": "coke",
          "name": "Coke",
          "price": 2.5,
          "external_item_links": [
            {
              "external_item_link_id": "def456",
              "external_item_link_type": "deliveroo",
              "outlet_id": 1
            },
            {
              "external_item_link_id": "ghi789",
              "external_item_link_type": "UberEats",
              "outlet_id": 7
            }
          ]
        }
      ]
    }
  ]
}'

Request

Request samples

Responses