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

1 {
2   "code": 2204,
3   "isSuccess": true,
4   "message": "string",
5   "menus": [
6     {
7       "id": 6018,
8       "name": "string",
9       "internalName": "string",
10       "channelType": "delivery",
11       "priority": 4303,
12       "isPublishable": false,
13       "warnings": [
14         "string",
15         "string"
16       ],
17       "storeCount": 1160,
18       "stores": [
19         {
20           "uuid": "string",
21           "name": "string"
22         },
23         {
24           "uuid": "string",
25           "name": "string"
26         }
27       ],
28       "startDate": "string",
29       "endDate": "string",
30       "operatingHours": [
31         {
32           "weekday": 4411,
33           "startTime": "09:00:00",
34           "endTime": "22:00:00"
35         },
36         {
37           "weekday": 6567,
38           "startTime": "09:00:00",
39           "endTime": "22:00:00"
40         }
41       ],
42       "storeOperatingHours": {
43         "key_0": [
44           {
45             "weekday": 7880,
46             "startTime": "09:00:00",
47             "endTime": "22:00:00"
48           },
49           {
50             "weekday": 6506,
51             "startTime": "09:00:00",
52             "endTime": "22:00:00"
53           }
54         ]
55       },
56       "groups": [
57         {
58           "id": 7112,
59           "name": "string",
60           "sortNum": 2177
61         },
62         {
63           "id": 7000,
64           "name": "string",
65           "sortNum": 2103
66         }
67       ],
68       "sections": [
69         {
70           "id": "string",
71           "name": "string",
72           "description": "string",
73           "displayType": "string",
74           "sortNum": 7706,
75           "visible": false,
76           "items": [
77             {
78               "id": 4104,
79               "itemId": 8354,
80               "itemCode": "string",
81               "name": "string",
82               "provider": "string",
83               "sortNum": 1323,
84               "visible": true,
85               "basePrice": 6784.806992585694,
86               "specialPrice": 8595.644194744984,
87               "deletedAt": "2000-06-05T07:47:05.893Z"
88             },
89             {
90               "id": 3170,
91               "itemId": 3076,
92               "itemCode": "string",
93               "name": "string",
94               "provider": "string",
95               "sortNum": 7375,
96               "visible": true,
97               "basePrice": 2597.507778631285,
98               "specialPrice": 8644.923122235046,
99               "deletedAt": "2010-02-24T03:10:57.758Z"
100             }
101           ],
102           "createdAt": "string",
103           "updatedAt": "string"
104         },
105         {
106           "id": "string",
107           "name": "string",
108           "description": "string",
109           "displayType": "string",
110           "sortNum": 9086,
111           "visible": true,
112           "items": [
113             {
114               "id": 9099,
115               "itemId": 5839,
116               "itemCode": "string",
117               "name": "string",
118               "provider": "string",
119               "sortNum": 8350,
120               "visible": true,
121               "basePrice": 2476.883828984275,
122               "specialPrice": 6121.1109386762755,
123               "deletedAt": "1995-07-29T01:58:29.469Z"
124             },
125             {
126               "id": 5692,
127               "itemId": 4953,
128               "itemCode": "string",
129               "name": "string",
130               "provider": "string",
131               "sortNum": 1958,
132               "visible": false,
133               "basePrice": 2203.021618113716,
134               "specialPrice": 83.17636924654926,
135               "deletedAt": "1961-10-09T04:11:52.175Z"
136             }
137           ],
138           "createdAt": "string",
139           "updatedAt": "string"
140         }
141       ],
142       "createdAt": "string",
143       "updatedAt": "string",
144       "deletedAt": "string"
145     },
146     {
147       "id": 5872,
148       "name": "string",
149       "internalName": "string",
150       "channelType": "delivery",
151       "priority": 8351,
152       "isPublishable": true,
153       "warnings": [
154         "string",
155         "string"
156       ],
157       "storeCount": 4148,
158       "stores": [
159         {
160           "uuid": "string",
161           "name": "string"
162         },
163         {
164           "uuid": "string",
165           "name": "string"
166         }
167       ],
168       "startDate": "string",
169       "endDate": "string",
170       "operatingHours": [
171         {
172           "weekday": 6641,
173           "startTime": "09:00:00",
174           "endTime": "22:00:00"
175         },
176         {
177           "weekday": 588,
178           "startTime": "09:00:00",
179           "endTime": "22:00:00"
180         }
181       ],
182       "storeOperatingHours": {
183         "key_0": [
184           {
185             "weekday": 2077,
186             "startTime": "09:00:00",
187             "endTime": "22:00:00"
188           },
189           {
190             "weekday": 431,
191             "startTime": "09:00:00",
192             "endTime": "22:00:00"
193           }
194         ],
195         "key_1": [
196           {
197             "weekday": 132,
198             "startTime": "09:00:00",
199             "endTime": "22:00:00"
200           },
201           {
202             "weekday": 6594,
203             "startTime": "09:00:00",
204             "endTime": "22:00:00"
205           }
206         ]
207       },
208       "groups": [
209         {
210           "id": 3488,
211           "name": "string",
212           "sortNum": 8942
213         },
214         {
215           "id": 3458,
216           "name": "string",
217           "sortNum": 2924
218         }
219       ],
220       "sections": [
221         {
222           "id": "string",
223           "name": "string",
224           "description": "string",
225           "displayType": "string",
226           "sortNum": 2728,
227           "visible": true,
228           "items": [
229             {
230               "id": 9197,
231               "itemId": 6446,
232               "itemCode": "string",
233               "name": "string",
234               "provider": "string",
235               "sortNum": 8694,
236               "visible": false,
237               "basePrice": 3649.0158505772397,
238               "specialPrice": 7598.509882318489,
239               "deletedAt": "1972-05-21T23:10:46.559Z"
240             },
241             {
242               "id": 1666,
243               "itemId": 8378,
244               "itemCode": "string",
245               "name": "string",
246               "provider": "string",
247               "sortNum": 4786,
248               "visible": false,
249               "basePrice": 7592.261409815009,
250               "specialPrice": 4934.470826607549,
251               "deletedAt": "1969-05-02T10:07:06.384Z"
252             }
253           ],
254           "createdAt": "string",
255           "updatedAt": "string"
256         },
257         {
258           "id": "string",
259           "name": "string",
260           "description": "string",
261           "displayType": "string",
262           "sortNum": 4787,
263           "visible": true,
264           "items": [
265             {
266               "id": 165,
267               "itemId": 801,
268               "itemCode": "string",
269               "name": "string",
270               "provider": "string",
271               "sortNum": 2705,
272               "visible": false,
273               "basePrice": 9128.65015408029,
274               "specialPrice": 9308.681905930103,
275               "deletedAt": "1966-10-19T15:25:22.672Z"
276             },
277             {
278               "id": 3985,
279               "itemId": 3150,
280               "itemCode": "string",
281               "name": "string",
282               "provider": "string",
283               "sortNum": 1790,
284               "visible": false,
285               "basePrice": 5575.037170985737,
286               "specialPrice": 5741.240077687071,
287               "deletedAt": "1949-01-30T10:21:03.439Z"
288             }
289           ],
290           "createdAt": "string",
291           "updatedAt": "string"
292         }
293       ],
294       "createdAt": "string",
295       "updatedAt": "string",
296       "deletedAt": "string"
297     }
298   ],
299   "total": 2522
300 }

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.

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