List item and modifier option availability for an outlet

GET

http://localhost:8080/api/v1/outlets/:outletId/items/availability

GET

/api/v1/outlets/:outletId/items/availability

$ curl -G http://localhost:8080/api/v1/outlets/string/items/availability \
>      -H "X-Tenant-ID: string" \
>      -H "X-Api-Key: <apiKey>" \
>      -d limit=50 \
>      -d offset=0

1 {
2   "code": 6013,
3   "isSuccess": false,
4   "message": "string",
5   "items": [
6     {
7       "itemCode": "string",
8       "itemName": "string",
9       "sellAvailable": true,
10       "disabledUntil": "2021-08-17T06:28:32.022Z",
11       "isSnoozed": false
12     },
13     {
14       "itemCode": "string",
15       "itemName": "string",
16       "sellAvailable": false,
17       "disabledUntil": "1977-08-21T04:01:28.768Z",
18       "isSnoozed": false
19     }
20   ],
21   "itemsTotal": 9098,
22   "modifierOptions": [
23     {
24       "optionId": 2198,
25       "optionCode": "string",
26       "optionName": "string",
27       "modifierCode": "string",
28       "modifierName": "string",
29       "itemCode": "string",
30       "itemName": "string",
31       "isDisabled": false,
32       "disabledUntil": "1957-07-19T00:22:41.371Z",
33       "isSnoozed": false
34     },
35     {
36       "optionId": 1258,
37       "optionCode": "string",
38       "optionName": "string",
39       "modifierCode": "string",
40       "modifierName": "string",
41       "itemCode": "string",
42       "itemName": "string",
43       "isDisabled": true,
44       "disabledUntil": "2018-02-20T02:09:14.677Z",
45       "isSnoozed": false
46     }
47   ],
48   "modifierTotal": 9537,
49   "limit": 9062,
50   "offset": 1221
51 }

Returns paginated item and modifier option availability for a specific outlet, including snooze status (disabledUntil, isSnoozed) and sell availability.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

outletIdstringRequired

Outlet UUID

Query parameters

limitintegerOptional

Page size (max 200)

offsetintegerOptional

Pagination offset

Response

codeinteger

isSuccessboolean

messagestring

itemslist of objects

itemsTotalinteger

modifierOptionslist of objects

modifierTotalinteger

limitinteger

offsetinteger

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors