Sync products (legacy compat)

POST

http://localhost:8080/api/v1/menu/sync

POST

/api/v1/menu/sync

$ curl -X POST http://localhost:8080/api/v1/menu/sync \
>      -H "X-Tenant-ID: string" \
>      -H "X-Provider: cata" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "products": [
>     {
>       "itemCode": "PROD-001",
>       "name": "Margherita Pizza",
>       "basePrice": 12.5,
>       "internalName": "string",
>       "shortDescription": "string",
>       "description": "string",
>       "slug": "string",
>       "mainImageUrl": "http://VRLXTRfbzFVOwejp.bxnIKg2M,rs0wEgaTaDOzOgl8b1LWtZDEL5S1TlRT",
>       "externalImageUrl": "https://JgfydrZiYRcLbkVSlxHocQxewG.lssscbgAEL6oNl4CUuWxUaA4amPmZf3LfczFIg7oWf4ESo5k",
>       "specialPrice": 7548.007286127645,
>       "visible": true,
>       "pickupAvailable": true,
>       "deliveryAvailable": true,
>       "eatInAvailable": true,
>       "sortNum": 839,
>       "publishStatus": "string",
>       "productType": 2493,
>       "isBundle": false,
>       "isVariant": false,
>       "taxOverride": 1100.2022189287209,
>       "taxOverrideDelivery": 4015.9119760258345,
>       "taxOverrideEatIn": 687.695367386707,
>       "showStartDatetime": "1965-12-17T12:57:37.874Z",
>       "posCategory": "string",
>       "modifierGroups": [
>         {
>           "itemCode": "string",
>           "name": "string",
>           "inputType": "string",
>           "sortNum": 9462,
>           "minSelect": 3284,
>           "maxSelect": 2001,
>           "allowMultipleQty": true,
>           "options": [
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 7334.272827633257,
>               "sortNum": 19,
>               "asDefault": false,
>               "visible": true,
>               "taxOverride": 3913.9164388736503
>             },
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 410.56103835139135,
>               "sortNum": 7957,
>               "asDefault": true,
>               "visible": true,
>               "taxOverride": 3368.1486964031506
>             }
>           ]
>         },
>         {
>           "itemCode": "string",
>           "name": "string",
>           "inputType": "string",
>           "sortNum": 7246,
>           "minSelect": 7300,
>           "maxSelect": 7252,
>           "allowMultipleQty": true,
>           "options": [
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 6251.149452662439,
>               "sortNum": 9474,
>               "asDefault": true,
>               "visible": true,
>               "taxOverride": 5244.246848055738
>             },
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 4733.559872440632,
>               "sortNum": 9111,
>               "asDefault": false,
>               "visible": true,
>               "taxOverride": 9552.192762334953
>             }
>           ]
>         }
>       ],
>       "bundleSections": [
>         {
>           "itemCode": "string",
>           "name": "string",
>           "sortNum": 3360,
>           "minSelection": 773,
>           "maxSelection": 6068,
>           "items": [
>             {
>               "itemCode": "string",
>               "price": 6898.883235326874,
>               "sortNum": 8825
>             },
>             {
>               "itemCode": "string",
>               "price": 1518.724224819672,
>               "sortNum": 3041
>             }
>           ]
>         },
>         {
>           "itemCode": "string",
>           "name": "string",
>           "sortNum": 5808,
>           "minSelection": 374,
>           "maxSelection": 218,
>           "items": [
>             {
>               "itemCode": "string",
>               "price": 3796.7997334349925,
>               "sortNum": 3521
>             },
>             {
>               "itemCode": "string",
>               "price": 8451.087394422879,
>               "sortNum": 3994
>             }
>           ]
>         }
>       ],
>       "storePrices": [
>         {
>           "outletId": "string",
>           "basePrice": 5782.3484900378035,
>           "specialPrice": 8208.458459226651,
>           "sellAvailable": true
>         },
>         {
>           "outletId": "string",
>           "basePrice": 7289.5797393302855,
>           "specialPrice": 2736.1081555386036,
>           "sellAvailable": true
>         }
>       ]
>     },
>     {
>       "itemCode": "PROD-001",
>       "name": "Margherita Pizza",
>       "basePrice": 12.5,
>       "internalName": "string",
>       "shortDescription": "string",
>       "description": "string",
>       "slug": "string",
>       "mainImageUrl": "https://WqEbHiVfJiJgTyeHflYiAKEfJn.cspYJPf3VkHTs+ehVwK",
>       "externalImageUrl": "https://LbOjhymKMHAdxMdjjtfvclDYk.sePYUyAdCKSrcJzY",
>       "specialPrice": 8283.503163170737,
>       "visible": true,
>       "pickupAvailable": true,
>       "deliveryAvailable": true,
>       "eatInAvailable": true,
>       "sortNum": 2356,
>       "publishStatus": "string",
>       "productType": 5079,
>       "isBundle": false,
>       "isVariant": false,
>       "taxOverride": 3474.599486427523,
>       "taxOverrideDelivery": 7769.339098516779,
>       "taxOverrideEatIn": 4340.204363105949,
>       "showStartDatetime": "2016-02-20T04:53:49.609Z",
>       "posCategory": "string",
>       "modifierGroups": [
>         {
>           "itemCode": "string",
>           "name": "string",
>           "inputType": "string",
>           "sortNum": 1442,
>           "minSelect": 3846,
>           "maxSelect": 9077,
>           "allowMultipleQty": false,
>           "options": [
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 1644.0944932033053,
>               "sortNum": 3705,
>               "asDefault": true,
>               "visible": true,
>               "taxOverride": 2053.5831857778076
>             },
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 4330.1633246404945,
>               "sortNum": 1589,
>               "asDefault": true,
>               "visible": true,
>               "taxOverride": 5918.278447445704
>             }
>           ]
>         },
>         {
>           "itemCode": "string",
>           "name": "string",
>           "inputType": "string",
>           "sortNum": 1526,
>           "minSelect": 7884,
>           "maxSelect": 7170,
>           "allowMultipleQty": true,
>           "options": [
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 1282.3023741421703,
>               "sortNum": 7695,
>               "asDefault": true,
>               "visible": true,
>               "taxOverride": 7609.790730580774
>             },
>             {
>               "itemCode": "string",
>               "name": "string",
>               "additionalPrice": 3174.9245998302777,
>               "sortNum": 1964,
>               "asDefault": true,
>               "visible": true,
>               "taxOverride": 1032.8492845799065
>             }
>           ]
>         }
>       ],
>       "bundleSections": [
>         {
>           "itemCode": "string",
>           "name": "string",
>           "sortNum": 2117,
>           "minSelection": 4103,
>           "maxSelection": 909,
>           "items": [
>             {
>               "itemCode": "string",
>               "price": 2471.359837520377,
>               "sortNum": 4032
>             },
>             {
>               "itemCode": "string",
>               "price": 9348.318957088624,
>               "sortNum": 5617
>             }
>           ]
>         },
>         {
>           "itemCode": "string",
>           "name": "string",
>           "sortNum": 8507,
>           "minSelection": 3300,
>           "maxSelection": 4610,
>           "items": [
>             {
>               "itemCode": "string",
>               "price": 2522.166340548082,
>               "sortNum": 8318
>             },
>             {
>               "itemCode": "string",
>               "price": 8703.163223561889,
>               "sortNum": 1044
>             }
>           ]
>         }
>       ],
>       "storePrices": [
>         {
>           "outletId": "string",
>           "basePrice": 6464.373966534305,
>           "specialPrice": 4908.25460479771,
>           "sellAvailable": true
>         },
>         {
>           "outletId": "string",
>           "basePrice": 8088.649989226003,
>           "specialPrice": 1794.7088577110826,
>           "sellAvailable": true
>         }
>       ]
>     }
>   ]
> }'

1 {
2   "summary": {
3     "created": 3,
4     "updated": 2,
5     "deleted": 1,
6     "total": 5
7   },
8   "products": [
9     {
10       "id": "string",
11       "itemCode": "string",
12       "name": "string",
13       "originalName": "string",
14       "internalName": "string",
15       "shortDescription": "string",
16       "originalShortDescription": "string",
17       "description": "string",
18       "originalDescription": "string",
19       "slug": "string",
20       "mainImageUrl": "string",
21       "externalImageUrl": "string",
22       "basePrice": 1167.0204049509202,
23       "specialPrice": 1555.506923797798,
24       "visible": true,
25       "pickupAvailable": false,
26       "deliveryAvailable": true,
27       "eatInAvailable": false,
28       "sortNum": 86,
29       "publishStatus": "string",
30       "productType": 8359,
31       "isBundle": true,
32       "isVariant": false,
33       "taxOverride": 5295.1637678180805,
34       "taxOverrideDelivery": 7438.206505002993,
35       "taxOverrideEatIn": 1851.7350582512204,
36       "provider": "string",
37       "posCategory": "string",
38       "modifierGroups": [
39         {
40           "id": "string",
41           "itemCode": "string",
42           "name": "string",
43           "inputType": "string",
44           "sortNum": 2656,
45           "minSelect": 2853,
46           "maxSelect": 6119,
47           "allowMultipleQty": true,
48           "options": [
49             {
50               "id": "string",
51               "itemCode": "string",
52               "name": "string",
53               "additionalPrice": 6383.833260031899,
54               "sortNum": 5923,
55               "asDefault": false,
56               "visible": true,
57               "taxOverride": 3951.281789639747
58             },
59             {
60               "id": "string",
61               "itemCode": "string",
62               "name": "string",
63               "additionalPrice": 5344.702846632834,
64               "sortNum": 2764,
65               "asDefault": true,
66               "visible": false,
67               "taxOverride": 8746.664112233822
68             }
69           ]
70         },
71         {
72           "id": "string",
73           "itemCode": "string",
74           "name": "string",
75           "inputType": "string",
76           "sortNum": 1955,
77           "minSelect": 6479,
78           "maxSelect": 5489,
79           "allowMultipleQty": false,
80           "options": [
81             {
82               "id": "string",
83               "itemCode": "string",
84               "name": "string",
85               "additionalPrice": 2034.9168184609634,
86               "sortNum": 3855,
87               "asDefault": true,
88               "visible": false,
89               "taxOverride": 6412.665080829696
90             },
91             {
92               "id": "string",
93               "itemCode": "string",
94               "name": "string",
95               "additionalPrice": 7471.142593785438,
96               "sortNum": 2017,
97               "asDefault": false,
98               "visible": true,
99               "taxOverride": 3847.083928147819
100             }
101           ]
102         }
103       ],
104       "bundleSections": [
105         {
106           "id": "string",
107           "itemCode": "string",
108           "name": "string",
109           "sortNum": 8598,
110           "minSelection": 5854,
111           "maxSelection": 6098,
112           "items": [
113             {
114               "itemCode": "string",
115               "price": 6165.535679930831,
116               "sortNum": 8729
117             },
118             {
119               "itemCode": "string",
120               "price": 3969.0644983297775,
121               "sortNum": 5670
122             }
123           ]
124         },
125         {
126           "id": "string",
127           "itemCode": "string",
128           "name": "string",
129           "sortNum": 1649,
130           "minSelection": 8883,
131           "maxSelection": 2189,
132           "items": [
133             {
134               "itemCode": "string",
135               "price": 2207.2007378072976,
136               "sortNum": 3677
137             },
138             {
139               "itemCode": "string",
140               "price": 542.81422460007,
141               "sortNum": 2981
142             }
143           ]
144         }
145       ],
146       "createdAt": "1967-12-17T01:02:00.503Z",
147       "updatedAt": "2015-08-27T00:44:38.701Z"
148     },
149     {
150       "id": "string",
151       "itemCode": "string",
152       "name": "string",
153       "originalName": "string",
154       "internalName": "string",
155       "shortDescription": "string",
156       "originalShortDescription": "string",
157       "description": "string",
158       "originalDescription": "string",
159       "slug": "string",
160       "mainImageUrl": "string",
161       "externalImageUrl": "string",
162       "basePrice": 4104.111039141098,
163       "specialPrice": 222.46746884083234,
164       "visible": false,
165       "pickupAvailable": false,
166       "deliveryAvailable": true,
167       "eatInAvailable": true,
168       "sortNum": 9390,
169       "publishStatus": "string",
170       "productType": 5870,
171       "isBundle": false,
172       "isVariant": false,
173       "taxOverride": 9712.984321710492,
174       "taxOverrideDelivery": 5852.124728650667,
175       "taxOverrideEatIn": 7669.968755933447,
176       "provider": "string",
177       "posCategory": "string",
178       "modifierGroups": [
179         {
180           "id": "string",
181           "itemCode": "string",
182           "name": "string",
183           "inputType": "string",
184           "sortNum": 3954,
185           "minSelect": 1771,
186           "maxSelect": 5521,
187           "allowMultipleQty": true,
188           "options": [
189             {
190               "id": "string",
191               "itemCode": "string",
192               "name": "string",
193               "additionalPrice": 3110.652321778704,
194               "sortNum": 8334,
195               "asDefault": false,
196               "visible": true,
197               "taxOverride": 7194.0176961567295
198             },
199             {
200               "id": "string",
201               "itemCode": "string",
202               "name": "string",
203               "additionalPrice": 1808.6550318199434,
204               "sortNum": 9262,
205               "asDefault": false,
206               "visible": false,
207               "taxOverride": 7470.92608202246
208             }
209           ]
210         },
211         {
212           "id": "string",
213           "itemCode": "string",
214           "name": "string",
215           "inputType": "string",
216           "sortNum": 8804,
217           "minSelect": 3996,
218           "maxSelect": 236,
219           "allowMultipleQty": false,
220           "options": [
221             {
222               "id": "string",
223               "itemCode": "string",
224               "name": "string",
225               "additionalPrice": 5173.781836648776,
226               "sortNum": 1465,
227               "asDefault": true,
228               "visible": false,
229               "taxOverride": 8626.391692666095
230             },
231             {
232               "id": "string",
233               "itemCode": "string",
234               "name": "string",
235               "additionalPrice": 6044.901500990974,
236               "sortNum": 1763,
237               "asDefault": false,
238               "visible": true,
239               "taxOverride": 1860.7751810634188
240             }
241           ]
242         }
243       ],
244       "bundleSections": [
245         {
246           "id": "string",
247           "itemCode": "string",
248           "name": "string",
249           "sortNum": 3054,
250           "minSelection": 9461,
251           "maxSelection": 2520,
252           "items": [
253             {
254               "itemCode": "string",
255               "price": 7824.159297930262,
256               "sortNum": 2559
257             },
258             {
259               "itemCode": "string",
260               "price": 693.2096070357429,
261               "sortNum": 5975
262             }
263           ]
264         },
265         {
266           "id": "string",
267           "itemCode": "string",
268           "name": "string",
269           "sortNum": 4905,
270           "minSelection": 2865,
271           "maxSelection": 8714,
272           "items": [
273             {
274               "itemCode": "string",
275               "price": 8628.075669780681,
276               "sortNum": 6810
277             },
278             {
279               "itemCode": "string",
280               "price": 965.9485688551306,
281               "sortNum": 6572
282             }
283           ]
284         }
285       ],
286       "createdAt": "2000-04-20T14:30:56.020Z",
287       "updatedAt": "1978-06-05T11:00:33.254Z"
288     }
289   ]
290 }

Legacy compatibility endpoint that delegates to POST /api/v1/products/sync. Use /api/v1/products/sync for new integrations.

Authentication

X-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

productslist of objectsRequired

Response

summaryobject

productslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

Authentication

Headers

Request

Response

Errors