List all products

GET

http://localhost:8080/api/v1/products

GET

/api/v1/products

1 curl http://localhost:8080/api/v1/products \
2      -H "X-Tenant-ID: string" \
3      -H "X-Api-Key: <apiKey>"

1 {
2   "products": [
3     {
4       "id": "string",
5       "itemCode": "string",
6       "name": "string",
7       "originalName": "string",
8       "internalName": "string",
9       "shortDescription": "string",
10       "originalShortDescription": "string",
11       "description": "string",
12       "originalDescription": "string",
13       "slug": "string",
14       "mainImageUrl": "string",
15       "externalImageUrl": "string",
16       "basePrice": 3399.648581413606,
17       "specialPrice": 6040.137495828153,
18       "visible": true,
19       "pickupAvailable": false,
20       "deliveryAvailable": true,
21       "eatInAvailable": true,
22       "sortNum": 3011,
23       "publishStatus": "string",
24       "productType": 2322,
25       "isBundle": false,
26       "isVariant": false,
27       "taxOverride": 2589.9101987810714,
28       "taxOverrideDelivery": 4906.892183036156,
29       "taxOverrideEatIn": 3037.543126751636,
30       "provider": "string",
31       "posCategory": "string",
32       "modifierGroups": [
33         {
34           "id": "string",
35           "itemCode": "string",
36           "name": "string",
37           "inputType": "string",
38           "sortNum": 131,
39           "minSelect": 6620,
40           "maxSelect": 5327,
41           "allowMultipleQty": false,
42           "options": [
43             {
44               "id": "string",
45               "itemCode": "string",
46               "name": "string",
47               "additionalPrice": 2765.391988241699,
48               "sortNum": 6478,
49               "asDefault": true,
50               "visible": false,
51               "taxOverride": 9841.635055319406
52             },
53             {
54               "id": "string",
55               "itemCode": "string",
56               "name": "string",
57               "additionalPrice": 8463.991177353219,
58               "sortNum": 5069,
59               "asDefault": false,
60               "visible": true,
61               "taxOverride": 1529.315783941696
62             }
63           ]
64         },
65         {
66           "id": "string",
67           "itemCode": "string",
68           "name": "string",
69           "inputType": "string",
70           "sortNum": 2291,
71           "minSelect": 1706,
72           "maxSelect": 5880,
73           "allowMultipleQty": true,
74           "options": [
75             {
76               "id": "string",
77               "itemCode": "string",
78               "name": "string",
79               "additionalPrice": 5015.54009309886,
80               "sortNum": 9276,
81               "asDefault": false,
82               "visible": true,
83               "taxOverride": 4451.710240503002
84             },
85             {
86               "id": "string",
87               "itemCode": "string",
88               "name": "string",
89               "additionalPrice": 6482.746483266169,
90               "sortNum": 8187,
91               "asDefault": true,
92               "visible": true,
93               "taxOverride": 5072.519890019733
94             }
95           ]
96         }
97       ],
98       "bundleSections": [
99         {
100           "id": "string",
101           "itemCode": "string",
102           "name": "string",
103           "sortNum": 8662,
104           "minSelection": 2138,
105           "maxSelection": 2707,
106           "items": [
107             {
108               "itemCode": "string",
109               "price": 1650.1792452414609,
110               "sortNum": 5424
111             },
112             {
113               "itemCode": "string",
114               "price": 6974.417103010981,
115               "sortNum": 6017
116             }
117           ]
118         },
119         {
120           "id": "string",
121           "itemCode": "string",
122           "name": "string",
123           "sortNum": 2983,
124           "minSelection": 2502,
125           "maxSelection": 3105,
126           "items": [
127             {
128               "itemCode": "string",
129               "price": 4329.384733685453,
130               "sortNum": 2166
131             },
132             {
133               "itemCode": "string",
134               "price": 2743.8163313944597,
135               "sortNum": 5265
136             }
137           ]
138         }
139       ],
140       "createdAt": "1989-05-19T10:04:03.662Z",
141       "updatedAt": "2019-05-18T18:51:43.181Z"
142     },
143     {
144       "id": "string",
145       "itemCode": "string",
146       "name": "string",
147       "originalName": "string",
148       "internalName": "string",
149       "shortDescription": "string",
150       "originalShortDescription": "string",
151       "description": "string",
152       "originalDescription": "string",
153       "slug": "string",
154       "mainImageUrl": "string",
155       "externalImageUrl": "string",
156       "basePrice": 603.4629290531624,
157       "specialPrice": 4647.518569360746,
158       "visible": true,
159       "pickupAvailable": true,
160       "deliveryAvailable": true,
161       "eatInAvailable": true,
162       "sortNum": 5747,
163       "publishStatus": "string",
164       "productType": 7907,
165       "isBundle": false,
166       "isVariant": true,
167       "taxOverride": 7457.740002089743,
168       "taxOverrideDelivery": 7961.80430552476,
169       "taxOverrideEatIn": 2796.951986991534,
170       "provider": "string",
171       "posCategory": "string",
172       "modifierGroups": [
173         {
174           "id": "string",
175           "itemCode": "string",
176           "name": "string",
177           "inputType": "string",
178           "sortNum": 1917,
179           "minSelect": 1181,
180           "maxSelect": 671,
181           "allowMultipleQty": false,
182           "options": [
183             {
184               "id": "string",
185               "itemCode": "string",
186               "name": "string",
187               "additionalPrice": 8387.058985427038,
188               "sortNum": 4131,
189               "asDefault": false,
190               "visible": true,
191               "taxOverride": 2243.9780500950214
192             },
193             {
194               "id": "string",
195               "itemCode": "string",
196               "name": "string",
197               "additionalPrice": 6661.922616722684,
198               "sortNum": 5076,
199               "asDefault": true,
200               "visible": false,
201               "taxOverride": 5342.96742156591
202             }
203           ]
204         },
205         {
206           "id": "string",
207           "itemCode": "string",
208           "name": "string",
209           "inputType": "string",
210           "sortNum": 6382,
211           "minSelect": 7046,
212           "maxSelect": 5191,
213           "allowMultipleQty": false,
214           "options": [
215             {
216               "id": "string",
217               "itemCode": "string",
218               "name": "string",
219               "additionalPrice": 3460.2415666282104,
220               "sortNum": 1372,
221               "asDefault": true,
222               "visible": true,
223               "taxOverride": 8844.779412879394
224             },
225             {
226               "id": "string",
227               "itemCode": "string",
228               "name": "string",
229               "additionalPrice": 9624.687417995221,
230               "sortNum": 4779,
231               "asDefault": true,
232               "visible": true,
233               "taxOverride": 3853.777872795694
234             }
235           ]
236         }
237       ],
238       "bundleSections": [
239         {
240           "id": "string",
241           "itemCode": "string",
242           "name": "string",
243           "sortNum": 5816,
244           "minSelection": 281,
245           "maxSelection": 4417,
246           "items": [
247             {
248               "itemCode": "string",
249               "price": 7601.168795465261,
250               "sortNum": 7713
251             },
252             {
253               "itemCode": "string",
254               "price": 8252.641056061886,
255               "sortNum": 9095
256             }
257           ]
258         },
259         {
260           "id": "string",
261           "itemCode": "string",
262           "name": "string",
263           "sortNum": 1338,
264           "minSelection": 9811,
265           "maxSelection": 3149,
266           "items": [
267             {
268               "itemCode": "string",
269               "price": 6071.362604173036,
270               "sortNum": 1695
271             },
272             {
273               "itemCode": "string",
274               "price": 2760.9471174663568,
275               "sortNum": 4165
276             }
277           ]
278         }
279       ],
280       "createdAt": "2000-01-26T17:54:31.542Z",
281       "updatedAt": "1982-01-06T00:58:08.439Z"
282     }
283   ],
284   "total": 2261
285 }

Returns all active (non-deleted) products for the tenant.

Authentication

X-Api-Keystring

API Key authentication via header

Response

productslist of objects

totalinteger

Errors

401

Unauthorized Error

Authentication

Headers

Response

Errors