Sync menu for an outlet

POST

http://localhost:8080/api/v1/outlets/:outletId/menu

POST

/api/v1/outlets/:outletId/menu

$ curl -X POST http://localhost:8080/api/v1/outlets/string/menu \
>      -H "X-Tenant-ID: string" \
>      -H "X-Provider: cata" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '[
>   {
>     "menuId": "menu-golden-dragon-main",
>     "menu": "Golden Dragon Main Menu",
>     "menuType": 0,
>     "availabilities": [
>       {
>         "dayOfWeek": 1,
>         "startTime": "11:00",
>         "endTime": "22:00"
>       },
>       {
>         "dayOfWeek": 1,
>         "startTime": "11:00",
>         "endTime": "22:00"
>       }
>     ],
>     "categories": [
>       {
>         "name": "Dim Sum",
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       },
>       {
>         "name": "Dim Sum",
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       }
>     ],
>     "products": {
>       "key_0": {
>         "_id": "string",
>         "plu": "DIM-001",
>         "name": "Har Gow (Shrimp Dumpling)",
>         "description": "string",
>         "price": 1250,
>         "imageUrl": "string",
>         "visible": true,
>         "isCombo": true,
>         "isVariant": true,
>         "subProducts": [
>           "string",
>           "string"
>         ],
>         "deliveryTax": 10000,
>         "takeawayTax": 2892.661374725021,
>         "eatInTax": 6735.138740712719,
>         "productTags": [
>           4022,
>           7792
>         ]
>       }
>     },
>     "modifierGroups": {
>       "key_0": {
>         "plu": "string",
>         "name": "Spice Level",
>         "min": 7273.818019270171,
>         "max": 8853.58519730965,
>         "multiMax": 3213,
>         "isUpsell": false,
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       }
>     },
>     "modifiers": {
>       "key_0": {
>         "_id": "string",
>         "plu": "MOD-MILD",
>         "name": "Mild",
>         "description": "string",
>         "price": 0,
>         "imageUrl": "string",
>         "defaultQuantity": 1279,
>         "deliveryTax": 6065.568393779801,
>         "takeawayTax": 1702.1974084327885,
>         "eatInTax": 6871.748973105587,
>         "productTags": [
>           8809,
>           654
>         ],
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       },
>       "key_1": {
>         "_id": "string",
>         "plu": "MOD-MILD",
>         "name": "Mild",
>         "description": "string",
>         "price": 0,
>         "imageUrl": "string",
>         "defaultQuantity": 6230,
>         "deliveryTax": 1981.3402436030358,
>         "takeawayTax": 15.837828252966979,
>         "eatInTax": 3247.6482725454425,
>         "productTags": [
>           9053,
>           7762
>         ],
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       }
>     },
>     "snoozedProducts": {
>       "key_0": {
>         "plu": "string",
>         "snoozeStart": "2026-03-09T00:00:00Z",
>         "snoozeEnd": "2026-03-10T00:00:00Z"
>       },
>       "key_1": {
>         "plu": "string",
>         "snoozeStart": "2026-03-09T00:00:00Z",
>         "snoozeEnd": "2026-03-10T00:00:00Z"
>       }
>     }
>   },
>   {
>     "menuId": "menu-golden-dragon-main",
>     "menu": "Golden Dragon Main Menu",
>     "menuType": 0,
>     "availabilities": [
>       {
>         "dayOfWeek": 1,
>         "startTime": "11:00",
>         "endTime": "22:00"
>       },
>       {
>         "dayOfWeek": 1,
>         "startTime": "11:00",
>         "endTime": "22:00"
>       }
>     ],
>     "categories": [
>       {
>         "name": "Dim Sum",
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       },
>       {
>         "name": "Dim Sum",
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       }
>     ],
>     "products": {
>       "key_0": {
>         "_id": "string",
>         "plu": "DIM-001",
>         "name": "Har Gow (Shrimp Dumpling)",
>         "description": "string",
>         "price": 1250,
>         "imageUrl": "string",
>         "visible": true,
>         "isCombo": true,
>         "isVariant": false,
>         "subProducts": [
>           "string",
>           "string"
>         ],
>         "deliveryTax": 10000,
>         "takeawayTax": 6926.084339030969,
>         "eatInTax": 9102.586678708589,
>         "productTags": [
>           4593,
>           9904
>         ]
>       }
>     },
>     "modifierGroups": {
>       "key_0": {
>         "plu": "string",
>         "name": "Spice Level",
>         "min": 6769.446609178771,
>         "max": 1868.153445764924,
>         "multiMax": 3854,
>         "isUpsell": false,
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       },
>       "key_1": {
>         "plu": "string",
>         "name": "Spice Level",
>         "min": 288.64808104787977,
>         "max": 9213.40308076754,
>         "multiMax": 470,
>         "isUpsell": false,
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       },
>       "key_2": {
>         "plu": "string",
>         "name": "Spice Level",
>         "min": 2551.7430500984183,
>         "max": 4061.422386674731,
>         "multiMax": 6051,
>         "isUpsell": true,
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       }
>     },
>     "modifiers": {
>       "key_0": {
>         "_id": "string",
>         "plu": "MOD-MILD",
>         "name": "Mild",
>         "description": "string",
>         "price": 0,
>         "imageUrl": "string",
>         "defaultQuantity": 6477,
>         "deliveryTax": 687.7752352188371,
>         "takeawayTax": 870.272126256737,
>         "eatInTax": 9906.502522431841,
>         "productTags": [
>           6663,
>           3502
>         ],
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       },
>       "key_1": {
>         "_id": "string",
>         "plu": "MOD-MILD",
>         "name": "Mild",
>         "description": "string",
>         "price": 0,
>         "imageUrl": "string",
>         "defaultQuantity": 6362,
>         "deliveryTax": 7648.226607957873,
>         "takeawayTax": 2638.27970386896,
>         "eatInTax": 1804.3777697554942,
>         "productTags": [
>           2672,
>           4816
>         ],
>         "subProducts": [
>           "string",
>           "string"
>         ]
>       }
>     },
>     "snoozedProducts": {
>       "key_0": {
>         "plu": "string",
>         "snoozeStart": "2026-03-09T00:00:00Z",
>         "snoozeEnd": "2026-03-10T00:00:00Z"
>       },
>       "key_1": {
>         "plu": "string",
>         "snoozeStart": "2026-03-09T00:00:00Z",
>         "snoozeEnd": "2026-03-10T00:00:00Z"
>       }
>     }
>   }
> ]'

1 {
2   "status": "ok",
3   "summary": {
4     "menusProcessed": 4000,
5     "itemsSynced": 3112,
6     "modifiersSynced": 6563
7   },
8   "menus": [
9     {
10       "menuId": "string",
11       "itemCount": 516,
12       "categoryCount": 1185
13     },
14     {
15       "menuId": "string",
16       "itemCount": 9498,
17       "categoryCount": 5948
18     }
19   ]
20 }

Sync a full menu for a specific outlet. The outlet is identified by {outletId} (store UUID). The POS adapter resolves its own store identifier to the outlet UUID before calling this endpoint.

The request body is a JSON array of menu objects (one outlet can have multiple menus, e.g. delivery menu + pickup menu).

The endpoint processes synchronously within a single transaction: upserts menus, items, modifiers, bundle sections, operating hours, and store links.

Idempotent: calling with the same payload again updates existing records.

Sync a full menu for a specific outlet. The outlet is identified by `{outletId}` (store UUID). The POS adapter resolves its own store identifier to the outlet UUID before calling this endpoint. The request body is a **JSON array** of menu objects (one outlet can have multiple menus, e.g. delivery menu + pickup menu). The endpoint processes synchronously within a single transaction: upserts menus, items, modifiers, bundle sections, operating hours, and store links. **Idempotent:** calling with the same payload again updates existing records.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

outletIdstringRequired

Outlet UUID

Request

This endpoint expects a list of objects.

menuIdstringRequired

menuTypeintegerRequired

availabilitieslist of objectsRequired

categorieslist of objectsRequired

productsobjectRequired

modifierGroupsobjectRequired

modifiersobjectRequired

snoozedProductsobjectRequired

Response

statusstring

summaryobject

menuslist of objects

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Request

Response

Errors