Get draft menu summary / stats

GET

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

GET

/api/v1/menus/:menuId/summary

$ curl http://localhost:8080/api/v1/menus/1514/summary \
>      -H "X-Tenant-ID: string" \
>      -H "X-Api-Key: <apiKey>"

1 {
2   "code": 200,
3   "isSuccess": true,
4   "message": "success",
5   "summary": {
6     "totalItems": 8,
7     "itemsByProvider": {
8       "cata": 5,
9       "deliverect": 3
10     },
11     "outletCount": 3,
12     "priceOverrideCount": 2,
13     "outletOverrides": [
14       {
15         "outletUuid": "string",
16         "outletName": "string",
17         "itemVisibility": [
18           {
19             "itemCode": "string",
20             "itemName": "string",
21             "visible": false
22           },
23           {
24             "itemCode": "string",
25             "itemName": "string",
26             "visible": true
27           }
28         ],
29         "modifierOptionOverrides": [
30           {
31             "optionId": 2431,
32             "optionName": "string",
33             "modifierGroupId": 6407,
34             "isDisabled": false
35           },
36           {
37             "optionId": 3941,
38             "optionName": "string",
39             "modifierGroupId": 8614,
40             "isDisabled": false
41           }
42         ]
43       },
44       {
45         "outletUuid": "string",
46         "outletName": "string",
47         "itemVisibility": [
48           {
49             "itemCode": "string",
50             "itemName": "string",
51             "visible": false
52           },
53           {
54             "itemCode": "string",
55             "itemName": "string",
56             "visible": false
57           }
58         ],
59         "modifierOptionOverrides": [
60           {
61             "optionId": 1683,
62             "optionName": "string",
63             "modifierGroupId": 6658,
64             "isDisabled": false
65           },
66           {
67             "optionId": 875,
68             "optionName": "string",
69             "modifierGroupId": 816,
70             "isDisabled": true
71           }
72         ]
73       }
74     ]
75   }
76 }

Returns aggregated statistics for a draft menu: total items, item breakdown by provider, outlet count, price override count, and detailed per-outlet override lists (item visibility, modifier option overrides).

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

menuIdstringRequired

Response

codeinteger

isSuccessboolean

messagestring

summaryobject

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors