List all draft menus

GET

http://localhost:8080/api/v1/menus

GET

/api/v1/menus

curl -G http://localhost:8080/api/v1/menus \
     -H "X-Tenant-ID: string" \
     -H "X-Api-Key: <apiKey>" \
     -d status=archived

200api_v1_menus_List all draft menus_example

{
  "code": 2204,
  "isSuccess": true,
  "message": "string",
  "menus": [
    {
      "id": 6018,
      "name": "string",
      "internalName": "string",
      "channelType": "delivery",
      "priority": 4303,
      "isPublishable": false,
      "warnings": [
        "string",
        "string"
      ],
      "storeCount": 1160,
      "stores": [
        {
          "uuid": "string",
          "name": "string"
        },
        {
          "uuid": "string",
          "name": "string"
        }
      ],
      "startDate": "string",
      "endDate": "string",
      "operatingHours": [
        {
          "weekday": 4411,
          "startTime": "09:00:00",
          "endTime": "22:00:00"
        },
        {
          "weekday": 6567,
          "startTime": "09:00:00",
          "endTime": "22:00:00"
        }
      ],
      "storeOperatingHours": {
        "key_0": [
          {
            "weekday": 7880,
            "startTime": "09:00:00",
            "endTime": "22:00:00"
          },
          {
            "weekday": 6506,
            "startTime": "09:00:00",
            "endTime": "22:00:00"
          }
        ]
      },
      "groups": [
        {
          "id": 7112,
          "name": "string",
          "sortNum": 2177
        },
        {
          "id": 7000,
          "name": "string",
          "sortNum": 2103
        }
      ],
      "sections": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "displayType": "string",
          "sortNum": 7706,
          "visible": false,
          "items": [
            {
              "id": 4104,
              "itemId": 8354,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 1323,
              "visible": true,
              "basePrice": 6784.806992585694,
              "specialPrice": 8595.644194744984,
              "deletedAt": "2000-06-05T07:47:05.893Z"
            },
            {
              "id": 3170,
              "itemId": 3076,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 7375,
              "visible": true,
              "basePrice": 2597.507778631285,
              "specialPrice": 8644.923122235046,
              "deletedAt": "2010-02-24T03:10:57.758Z"
            }
          ],
          "createdAt": "string",
          "updatedAt": "string"
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "displayType": "string",
          "sortNum": 9086,
          "visible": true,
          "items": [
            {
              "id": 9099,
              "itemId": 5839,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 8350,
              "visible": true,
              "basePrice": 2476.883828984275,
              "specialPrice": 6121.1109386762755,
              "deletedAt": "1995-07-29T01:58:29.469Z"
            },
            {
              "id": 5692,
              "itemId": 4953,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 1958,
              "visible": false,
              "basePrice": 2203.021618113716,
              "specialPrice": 83.17636924654926,
              "deletedAt": "1961-10-09T04:11:52.175Z"
            }
          ],
          "createdAt": "string",
          "updatedAt": "string"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    },
    {
      "id": 5872,
      "name": "string",
      "internalName": "string",
      "channelType": "delivery",
      "priority": 8351,
      "isPublishable": true,
      "warnings": [
        "string",
        "string"
      ],
      "storeCount": 4148,
      "stores": [
        {
          "uuid": "string",
          "name": "string"
        },
        {
          "uuid": "string",
          "name": "string"
        }
      ],
      "startDate": "string",
      "endDate": "string",
      "operatingHours": [
        {
          "weekday": 6641,
          "startTime": "09:00:00",
          "endTime": "22:00:00"
        },
        {
          "weekday": 588,
          "startTime": "09:00:00",
          "endTime": "22:00:00"
        }
      ],
      "storeOperatingHours": {
        "key_0": [
          {
            "weekday": 2077,
            "startTime": "09:00:00",
            "endTime": "22:00:00"
          },
          {
            "weekday": 431,
            "startTime": "09:00:00",
            "endTime": "22:00:00"
          }
        ],
        "key_1": [
          {
            "weekday": 132,
            "startTime": "09:00:00",
            "endTime": "22:00:00"
          },
          {
            "weekday": 6594,
            "startTime": "09:00:00",
            "endTime": "22:00:00"
          }
        ]
      },
      "groups": [
        {
          "id": 3488,
          "name": "string",
          "sortNum": 8942
        },
        {
          "id": 3458,
          "name": "string",
          "sortNum": 2924
        }
      ],
      "sections": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "displayType": "string",
          "sortNum": 2728,
          "visible": true,
          "items": [
            {
              "id": 9197,
              "itemId": 6446,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 8694,
              "visible": false,
              "basePrice": 3649.0158505772397,
              "specialPrice": 7598.509882318489,
              "deletedAt": "1972-05-21T23:10:46.559Z"
            },
            {
              "id": 1666,
              "itemId": 8378,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 4786,
              "visible": false,
              "basePrice": 7592.261409815009,
              "specialPrice": 4934.470826607549,
              "deletedAt": "1969-05-02T10:07:06.384Z"
            }
          ],
          "createdAt": "string",
          "updatedAt": "string"
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "displayType": "string",
          "sortNum": 4787,
          "visible": true,
          "items": [
            {
              "id": 165,
              "itemId": 801,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 2705,
              "visible": false,
              "basePrice": 9128.65015408029,
              "specialPrice": 9308.681905930103,
              "deletedAt": "1966-10-19T15:25:22.672Z"
            },
            {
              "id": 3985,
              "itemId": 3150,
              "itemCode": "string",
              "name": "string",
              "provider": "string",
              "sortNum": 1790,
              "visible": false,
              "basePrice": 5575.037170985737,
              "specialPrice": 5741.240077687071,
              "deletedAt": "1949-01-30T10:21:03.439Z"
            }
          ],
          "createdAt": "string",
          "updatedAt": "string"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  ],
  "total": 2522
}

Returns all draft menus for the tenant, ordered by priority.

Query parameters:

status=archived — returns archived (soft-deleted) menus instead of active ones. Archived menus include a deletedAt timestamp showing when they were archived.

Authentication

X-Api-Keystring

API Key authentication via header

Query parameters

statusstringOptional

Filter by status. Use archived to list soft-deleted menus.

Response

codeinteger

isSuccessboolean

messagestring

menuslist of objects

totalinteger

Authentication

Headers

Query parameters

Response