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
  • Stocks
    • Outlet Stocks
      GET
  • Users
    • User Sync
      POST
  1. Menus

Menu Details

GET
/menus/{menu_id}
Returns the full structure for the menu with the specified id.

Request

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

Header Params

Request 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 GET 'https://api.atlas.kitchen/admin/v1/menus/826419' \
--header 'X-Merchant-Id;' \
--header 'X-Api-Key;'

Responses

🟢200Success
application/json
Body

Example
{
    "id": 8921,
    "identifier": "atlas-kitchen-2024",
    "brand_id": 231,
    "start_date": "2024-01-01",
    "end_date": "2024-12-31",
    "name": "2024 Menu",
    "state": "published",
    "tag_list": [],
    "lead_time": null,
    "created_at": 1723628097,
    "updated_at": 1723780269,
    "sections": [
        {
            "id": 1010,
            "identifier": "2024-recommendations",
            "name": "Recommendations",
            "description": "Discover our recommendations, celebrated for their exceptional flavor and quality.",
            "display_order": 0,
            "image_url": null,
            "products": [],
            "sub_sections": [
                {
                    "id": 1911,
                    "identifier": "2024-chef-recommendation",
                    "display_order": 0,
                    "name": "Chef's Recommendation",
                    "description": "Discover Chef Luca Moretti’s top picks, featuring extraordinary flavors and craftsmanship.",
                    "image_url": "https://storage.io/7shdahd81hdhsa",
                    "products": [
                        {
                            "id": 2638,
                            "sku": "truffle-infused-mushroom-risotto",
                            "name": "Truffle-Infused Mushroom Risotto",
                            "description": "Creamy risotto with truffle oil, wild mushrooms, and Parmesan. Pure indulgence.",
                            "display_order": 0,
                            "brand_id": 231,
                            "price_cents": 2000,
                            "currency": "SGD",
                            "horizontal_image_url": "https://storage.io/dasjjkdhfkjd938",
                            "is_configurable": false,
                            "promotional_label_bg_color": "#333AE3",
                            "promotional_label_font_color": "#333AE3",
                            "promotional_label_text": "Chef's Recommendation",
                            "nutri_grade": null,
                            "sugar_level": null,
                            "product_tags": [],
                            "report_category": null,
                            "archived_at": null,
                            "item_modifier_groups": []
                        }
                    ]
                },
                {
                    "id": 1912,
                    "identifier": "2024-customer-recommendation",
                    "display_order": 0,
                    "name": "Customer's Recommendation",
                    "description": "Try our customer favorites, beloved for their outstanding flavor and quality.",
                    "image_url": "https://storage.io/7shdahd81hdhsa",
                    "products": [
                        {
                            "id": 2639,
                            "sku": "spicy-lemon-garlic-skewers",
                            "name": "Spicy Lemon-Garlic Chicken Skewers",
                            "description": "Tender meat skewers marinated in zesty lemon and spicy garlic.",
                            "display_order": 0,
                            "brand_id": 231,
                            "price_cents": 1000,
                            "currency": "SGD",
                            "horizontal_image_url": "https://storage.io/abcd1234efgh5678",
                            "is_configurable": true,
                            "promotional_label_bg_color": "#FF6F61",
                            "promotional_label_font_color": "#FFFFFF",
                            "promotional_label_text": "Customer Favorite",
                            "nutri_grade": null,
                            "sugar_level": null,
                            "product_tags": [],
                            "report_category": null,
                            "archived_at": null,
                            "item_modifier_groups": [
                                {
                                    "id": 3778,
                                    "display_order": 0,
                                    "is_fixed": false,
                                    "hide_thumbnails": false,
                                    "archived": false,
                                    "modifier_group": {
                                        "id": 4627,
                                        "identifier": "spicy-lemon-garlic-skewers-protein",
                                        "name": "Choose your protein",
                                        "max_quantity_per_modifier": 1,
                                        "print_large_modifiers": false,
                                        "printable": true,
                                        "selection_required_max": 1,
                                        "selection_required_min": 1,
                                        "archived_at": null,
                                        "modifiers": [
                                            {
                                                "id": 5743,
                                                "default_quantity": 0,
                                                "display_order": 0,
                                                "price_cents_override": null,
                                                "upsell_label": null,
                                                "upsell_label_background_color": null,
                                                "upsell_label_text_color": null,
                                                "item": {
                                                    "id": 2639,
                                                    "identifier": "skewer-protein-chicken",
                                                    "name": "Chicken",
                                                    "description": null,
                                                    "nutri_grade": null,
                                                    "price_cents": 0,
                                                    "sugar_level": null,
                                                    "type": "Component"
                                                }
                                            },
                                            {
                                                "id": 5744,
                                                "default_quantity": 0,
                                                "display_order": 1,
                                                "price_cents_override": null,
                                                "upsell_label": null,
                                                "upsell_label_background_color": null,
                                                "upsell_label_text_color": null,
                                                "item": {
                                                    "id": 2641,
                                                    "identifier": "skewer-protein-pork",
                                                    "name": "Pork",
                                                    "description": null,
                                                    "nutri_grade": null,
                                                    "price_cents": 0,
                                                    "sugar_level": null,
                                                    "type": "Component"
                                                }
                                            },
                                            {
                                                "id": 5745,
                                                "default_quantity": 0,
                                                "display_order": 2,
                                                "price_cents_override": null,
                                                "upsell_label": null,
                                                "upsell_label_background_color": null,
                                                "upsell_label_text_color": null,
                                                "item": {
                                                    "id": 2642,
                                                    "identifier": "skewer-protein-beef",
                                                    "name": "Beef",
                                                    "description": null,
                                                    "nutri_grade": null,
                                                    "price_cents": 300,
                                                    "sugar_level": null,
                                                    "type": "Component"
                                                }
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "id": 1011,
            "identifier": "2024-desserts",
            "name": "Desserts",
            "description": "Indulge in our delectable desserts, crafted for ultimate sweet satisfaction.",
            "display_order": 0,
            "image_url": null,
            "sub_sections": [],
            "products": [
                {
                    "id": 2640,
                    "sku": "classic-chocolate-lava-cake",
                    "name": "Classic Chocolate Lava Cake",
                    "description": "Decadent molten chocolate cake with a gooey, rich center.",
                    "display_order": 0,
                    "brand_id": 231,
                    "price_cents": 1000,
                    "currency": "SGD",
                    "horizontal_image_url": "https://storage.io/wxyz5678ijkl9101",
                    "is_configurable": false,
                    "promotional_label_bg_color": null,
                    "promotional_label_font_color": null,
                    "promotional_label_text": null,
                    "nutri_grade": null,
                    "sugar_level": null,
                    "product_tags": [
                        "dessert",
                        "chocolate"
                    ],
                    "report_category": "desserts",
                    "archived_at": null,
                    "item_modifier_groups": []
                }
            ]
        }
    ]
}
🟠404Not Found
🔴500Server Error
🟠401Unauthorized
Modified at 2024-10-04 04:16:25
Previous
Menu List
Next
Menu Create or Update
Built with