Menu List - Atlas Open API

Request

Authorization

Add parameter in header

X-Api-Key

Example:

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

Header Params

X-Merchant-ID

string

required

Your merchant ID

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200ListResponse

application/json

Body

object

string

required

Specifies the object type of the items (menu)

items

array [object {11}]

required

id

integer

required

The id of the menu; used in menu-related API requests

identifier

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

name

string

required

Name of the menu

state

enum<string>

required

Contains the publishing state of the menu.

Allowed values:

publisheddraft

tag_list

array[string]

required

Contains the tags for the menu

lead_time

integer

required

created_at

integer

required

Timestamp on object creation. Format: unix time

updated_at

integer

required

Timestamp on last object update. Format: unix time

Example

{
  "object": "menu",
  "items": [
    {
      "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
    },
    {
      "id": 8922,
      "identifier": "atlas-kitchen-christmas-specials",
      "brand_id": 231,
      "start_date": "2024-12-01",
      "end_date": "2025-01-15",
      "name": "Christmas Specials",
      "state": "draft",
      "tag_list": [
        "christmas"
      ],
      "lead_time": null,
      "created_at": 1723628097,
      "updated_at": 1723780269
    },
    {
      "id": 8924,
      "identifier": "atlas-kitchen-grabfood",
      "brand_id": 231,
      "start_date": "2024-01-01",
      "end_date": "2024-12-31",
      "name": "Grabfood Menu",
      "state": "published",
      "tag_list": [
        "grabfood",
        "delivery"
      ],
      "lead_time": null,
      "created_at": 1723628097,
      "updated_at": 1723780269
    }
  ]
}

🔴500Server Error

🟠401Unauthorized