Sync products (legacy compat)

POST

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

POST

/api/v1/menu/sync

1 curl -X POST http://localhost:8080/api/v1/menu/sync \
2      -H "X-Tenant-ID: string" \
3      -H "X-Provider: cata" \
4      -H "X-Api-Key: <apiKey>" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "products": [
8     {
9       "itemCode": "PROD-001",
10       "name": "Margherita Pizza",
11       "basePrice": 12.5,
12       "internalName": "string",
13       "shortDescription": "string",
14       "description": "string",
15       "slug": "string",
16       "mainImageUrl": "http://VRLXTRfbzFVOwejp.bxnIKg2M,rs0wEgaTaDOzOgl8b1LWtZDEL5S1TlRT",
17       "externalImageUrl": "https://JgfydrZiYRcLbkVSlxHocQxewG.lssscbgAEL6oNl4CUuWxUaA4amPmZf3LfczFIg7oWf4ESo5k",
18       "specialPrice": 7548.007286127645,
19       "visible": true,
20       "pickupAvailable": true,
21       "deliveryAvailable": true,
22       "eatInAvailable": true,
23       "sortNum": 839,
24       "publishStatus": "string",
25       "productType": 2493,
26       "isBundle": false,
27       "isVariant": false,
28       "taxOverride": 1100.2022189287209,
29       "taxOverrideDelivery": 4015.9119760258345,
30       "taxOverrideEatIn": 687.695367386707,
31       "showStartDatetime": "1965-12-17T12:57:37.874Z",
32       "posCategory": "string",
33       "modifierGroups": [
34         {
35           "itemCode": "string",
36           "name": "string",
37           "inputType": "string",
38           "sortNum": 9462,
39           "minSelect": 3284,
40           "maxSelect": 2001,
41           "allowMultipleQty": true,
42           "options": [
43             {
44               "itemCode": "string",
45               "name": "string",
46               "additionalPrice": 7334.272827633257,
47               "sortNum": 19,
48               "asDefault": false,
49               "visible": true,
50               "taxOverride": 3913.9164388736503
51             },
52             {
53               "itemCode": "string",
54               "name": "string",
55               "additionalPrice": 410.56103835139135,
56               "sortNum": 7957,
57               "asDefault": true,
58               "visible": true,
59               "taxOverride": 3368.1486964031506
60             }
61           ]
62         },
63         {
64           "itemCode": "string",
65           "name": "string",
66           "inputType": "string",
67           "sortNum": 7246,
68           "minSelect": 7300,
69           "maxSelect": 7252,
70           "allowMultipleQty": true,
71           "options": [
72             {
73               "itemCode": "string",
74               "name": "string",
75               "additionalPrice": 6251.149452662439,
76               "sortNum": 9474,
77               "asDefault": true,
78               "visible": true,
79               "taxOverride": 5244.246848055738
80             },
81             {
82               "itemCode": "string",
83               "name": "string",
84               "additionalPrice": 4733.559872440632,
85               "sortNum": 9111,
86               "asDefault": false,
87               "visible": true,
88               "taxOverride": 9552.192762334953
89             }
90           ]
91         }
92       ],
93       "bundleSections": [
94         {
95           "itemCode": "string",
96           "name": "string",
97           "sortNum": 3360,
98           "minSelection": 773,
99           "maxSelection": 6068,
100           "items": [
101             {
102               "itemCode": "string",
103               "price": 6898.883235326874,
104               "sortNum": 8825
105             },
106             {
107               "itemCode": "string",
108               "price": 1518.724224819672,
109               "sortNum": 3041
110             }
111           ]
112         },
113         {
114           "itemCode": "string",
115           "name": "string",
116           "sortNum": 5808,
117           "minSelection": 374,
118           "maxSelection": 218,
119           "items": [
120             {
121               "itemCode": "string",
122               "price": 3796.7997334349925,
123               "sortNum": 3521
124             },
125             {
126               "itemCode": "string",
127               "price": 8451.087394422879,
128               "sortNum": 3994
129             }
130           ]
131         }
132       ],
133       "storePrices": [
134         {
135           "outletId": "string",
136           "basePrice": 5782.3484900378035,
137           "specialPrice": 8208.458459226651,
138           "sellAvailable": true
139         },
140         {
141           "outletId": "string",
142           "basePrice": 7289.5797393302855,
143           "specialPrice": 2736.1081555386036,
144           "sellAvailable": true
145         }
146       ]
147     },
148     {
149       "itemCode": "PROD-001",
150       "name": "Margherita Pizza",
151       "basePrice": 12.5,
152       "internalName": "string",
153       "shortDescription": "string",
154       "description": "string",
155       "slug": "string",
156       "mainImageUrl": "https://WqEbHiVfJiJgTyeHflYiAKEfJn.cspYJPf3VkHTs+ehVwK",
157       "externalImageUrl": "https://LbOjhymKMHAdxMdjjtfvclDYk.sePYUyAdCKSrcJzY",
158       "specialPrice": 8283.503163170737,
159       "visible": true,
160       "pickupAvailable": true,
161       "deliveryAvailable": true,
162       "eatInAvailable": true,
163       "sortNum": 2356,
164       "publishStatus": "string",
165       "productType": 5079,
166       "isBundle": false,
167       "isVariant": false,
168       "taxOverride": 3474.599486427523,
169       "taxOverrideDelivery": 7769.339098516779,
170       "taxOverrideEatIn": 4340.204363105949,
171       "showStartDatetime": "2016-02-20T04:53:49.609Z",
172       "posCategory": "string",
173       "modifierGroups": [
174         {
175           "itemCode": "string",
176           "name": "string",
177           "inputType": "string",
178           "sortNum": 1442,
179           "minSelect": 3846,
180           "maxSelect": 9077,
181           "allowMultipleQty": false,
182           "options": [
183             {
184               "itemCode": "string",
185               "name": "string",
186               "additionalPrice": 1644.0944932033053,
187               "sortNum": 3705,
188               "asDefault": true,
189               "visible": true,
190               "taxOverride": 2053.5831857778076
191             },
192             {
193               "itemCode": "string",
194               "name": "string",
195               "additionalPrice": 4330.1633246404945,
196               "sortNum": 1589,
197               "asDefault": true,
198               "visible": true,
199               "taxOverride": 5918.278447445704
200             }
201           ]
202         },
203         {
204           "itemCode": "string",
205           "name": "string",
206           "inputType": "string",
207           "sortNum": 1526,
208           "minSelect": 7884,
209           "maxSelect": 7170,
210           "allowMultipleQty": true,
211           "options": [
212             {
213               "itemCode": "string",
214               "name": "string",
215               "additionalPrice": 1282.3023741421703,
216               "sortNum": 7695,
217               "asDefault": true,
218               "visible": true,
219               "taxOverride": 7609.790730580774
220             },
221             {
222               "itemCode": "string",
223               "name": "string",
224               "additionalPrice": 3174.9245998302777,
225               "sortNum": 1964,
226               "asDefault": true,
227               "visible": true,
228               "taxOverride": 1032.8492845799065
229             }
230           ]
231         }
232       ],
233       "bundleSections": [
234         {
235           "itemCode": "string",
236           "name": "string",
237           "sortNum": 2117,
238           "minSelection": 4103,
239           "maxSelection": 909,
240           "items": [
241             {
242               "itemCode": "string",
243               "price": 2471.359837520377,
244               "sortNum": 4032
245             },
246             {
247               "itemCode": "string",
248               "price": 9348.318957088624,
249               "sortNum": 5617
250             }
251           ]
252         },
253         {
254           "itemCode": "string",
255           "name": "string",
256           "sortNum": 8507,
257           "minSelection": 3300,
258           "maxSelection": 4610,
259           "items": [
260             {
261               "itemCode": "string",
262               "price": 2522.166340548082,
263               "sortNum": 8318
264             },
265             {
266               "itemCode": "string",
267               "price": 8703.163223561889,
268               "sortNum": 1044
269             }
270           ]
271         }
272       ],
273       "storePrices": [
274         {
275           "outletId": "string",
276           "basePrice": 6464.373966534305,
277           "specialPrice": 4908.25460479771,
278           "sellAvailable": true
279         },
280         {
281           "outletId": "string",
282           "basePrice": 8088.649989226003,
283           "specialPrice": 1794.7088577110826,
284           "sellAvailable": true
285         }
286       ]
287     }
288   ]
289 }'

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.

Sync products (legacy compat)

Authentication

Headers

Request

Response

Errors