Atlas Open API
  1. Menus
Atlas Open API
  • Introduction
  • Authentication
  • Date and Time
  • Errors
  • Webhooks
    • Incoming
      • Reservations (BETA)
    • Outgoing
      • Menus, Stocks, Orders, Outlets, Users
  • Menus
    • Menu List
      GET
    • Menu Details
      GET
    • Menu Create or Update
      POST
  • Orders
    • Create Order
      POST
    • Order Details
      GET
    • Update Order
      PATCH
    • Order Details (with Identifier)
      GET
  • Stocks
    • Outlet Stocks
      GET
  • Users
    • User Sync
      POST
  • Tables
    • Tables
      GET
  • Carts
    • Create cart
      POST
  1. Menus

Menu Create or Update

POST
/menus

Known limitations:#

Image upload is currently not supported
If the menu payload is too big, the request may timeout, but the process will continue to run

Request

Authorization
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
Header Params

Body Params application/json

Example
{
    "identifier": "configurable-item-menu",
    "name": "Configurable Item Menu",
    "start_date": "2025-07-10",
    "end_date": "2035-07-10",
    "brand_id": 1,
    "sections": [
        {
            "identifier": "burgers",
            "name": "Burgers",
            "products": [
                {
                    "sku": "custom-burger",
                    "name": "Custom Burger",
                    "price_cents": 1200,
                    "product_tags": [
                        "burger",
                        "custom"
                    ],
                    "kitchen_tags": [],
                    "report_category": "burger",
                    "modifier_groups": [
                        {
                            "identifier": "burger-patty",
                            "name": "Choose Your Patty",
                            "selection_required_min": 1,
                            "selection_required_max": 1,
                            "modifiers": [
                                {
                                    "sku": "beef-patty",
                                    "name": "Beef Patty",
                                    "price_cents": 0,
                                    "product_tags": [],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "external_item_links": [
                                        {
                                            "external_item_link_id": "ext-beef-patty",
                                            "external_item_link_type": "deliveroo",
                                            "outlet_id": 1
                                        }
                                    ]
                                },
                                {
                                    "sku": "chicken-patty",
                                    "name": "Chicken Patty",
                                    "price_cents": 100,
                                    "product_tags": [],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "external_item_links": [
                                        {
                                            "external_item_link_id": "ext-chicken-patty",
                                            "external_item_link_type": "deliveroo",
                                            "outlet_id": 1
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "identifier": "burger-toppings",
                            "name": "Add Toppings",
                            "selection_required_min": 0,
                            "selection_required_max": 2,
                            "modifiers": [
                                {
                                    "sku": "lettuce",
                                    "name": "Lettuce",
                                    "price_cents": 50,
                                    "product_tags": [
                                        "topping"
                                    ],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "external_item_links": [
                                        {
                                            "external_item_link_id": "ext-lettuce",
                                            "external_item_link_type": "deliveroo",
                                            "outlet_id": 1
                                        }
                                    ]
                                },
                                {
                                    "sku": "tomato",
                                    "name": "Tomato",
                                    "price_cents": 50,
                                    "product_tags": [
                                        "topping"
                                    ],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "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
                        }
                    ]
                },
                {
                    "sku": "veggie-burger",
                    "name": "Veggie Burger",
                    "price_cents": 999,
                    "product_tags": [
                        "burger"
                    ],
                    "kitchen_tags": [],
                    "report_category": "burger"
                }
            ]
        },
        {
            "identifier": "drinks",
            "name": "Drinks",
            "products": [
                {
                    "sku": "coke",
                    "name": "Coke",
                    "price_cents": 250,
                    "product_tags": [],
                    "kitchen_tags": [],
                    "report_category": "drink",
                    "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 Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.atlas.kitchen/admin/v1/menus' \
--header 'X-Merchant-ID: ak-qa-uat-3' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identifier": "configurable-item-menu",
    "name": "Configurable Item Menu",
    "start_date": "2025-07-10",
    "end_date": "2035-07-10",
    "brand_id": 1,
    "sections": [
        {
            "identifier": "burgers",
            "name": "Burgers",
            "products": [
                {
                    "sku": "custom-burger",
                    "name": "Custom Burger",
                    "price_cents": 1200,
                    "product_tags": [
                        "burger",
                        "custom"
                    ],
                    "kitchen_tags": [],
                    "report_category": "burger",
                    "modifier_groups": [
                        {
                            "identifier": "burger-patty",
                            "name": "Choose Your Patty",
                            "selection_required_min": 1,
                            "selection_required_max": 1,
                            "modifiers": [
                                {
                                    "sku": "beef-patty",
                                    "name": "Beef Patty",
                                    "price_cents": 0,
                                    "product_tags": [],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "external_item_links": [
                                        {
                                            "external_item_link_id": "ext-beef-patty",
                                            "external_item_link_type": "deliveroo",
                                            "outlet_id": 1
                                        }
                                    ]
                                },
                                {
                                    "sku": "chicken-patty",
                                    "name": "Chicken Patty",
                                    "price_cents": 100,
                                    "product_tags": [],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "external_item_links": [
                                        {
                                            "external_item_link_id": "ext-chicken-patty",
                                            "external_item_link_type": "deliveroo",
                                            "outlet_id": 1
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "identifier": "burger-toppings",
                            "name": "Add Toppings",
                            "selection_required_min": 0,
                            "selection_required_max": 2,
                            "modifiers": [
                                {
                                    "sku": "lettuce",
                                    "name": "Lettuce",
                                    "price_cents": 50,
                                    "product_tags": [
                                        "topping"
                                    ],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "external_item_links": [
                                        {
                                            "external_item_link_id": "ext-lettuce",
                                            "external_item_link_type": "deliveroo",
                                            "outlet_id": 1
                                        }
                                    ]
                                },
                                {
                                    "sku": "tomato",
                                    "name": "Tomato",
                                    "price_cents": 50,
                                    "product_tags": [
                                        "topping"
                                    ],
                                    "kitchen_tags": [],
                                    "report_category": "",
                                    "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
                        }
                    ]
                },
                {
                    "sku": "veggie-burger",
                    "name": "Veggie Burger",
                    "price_cents": 999,
                    "product_tags": [
                        "burger"
                    ],
                    "kitchen_tags": [],
                    "report_category": "burger"
                }
            ]
        },
        {
            "identifier": "drinks",
            "name": "Drinks",
            "products": [
                {
                    "sku": "coke",
                    "name": "Coke",
                    "price_cents": 250,
                    "product_tags": [],
                    "kitchen_tags": [],
                    "report_category": "drink",
                    "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
                        }
                    ]
                }
            ]
        }
    ]
}'

Responses

🟢200Success
This response does not have a body.
🟠401Unauthorized
🟠422Invalid Parameter
Modified at 2025-10-21 08:47:20
Previous
Menu Details
Next
Create Order
Built with