@things-factory/operato-hub 4.3.103 → 4.3.104

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/openapi/v1/authetication.yaml +108 -0
  2. package/openapi/v1/bizplace.yaml +74 -0
  3. package/openapi/v1/contact-point.yaml +258 -89
  4. package/openapi/v1/inbound.yaml +626 -304
  5. package/openapi/v1/inventory.yaml +211 -179
  6. package/openapi/v1/marketplace.yaml +843 -0
  7. package/openapi/v1/outbound.yaml +1311 -569
  8. package/openapi/v1/partner.yaml +80 -0
  9. package/openapi/v1/product.yaml +507 -175
  10. package/openapi/v1.yaml +39 -7
  11. package/package.json +3 -3
  12. package/openapi/v1/ecommerce.yaml +0 -549
package/openapi/v1/product.yaml CHANGED
@@ -1,218 +1,558 @@
1
1
  definitions:
2
- Product:
2
+ # AddProduct
3
+ AddProduct:
3
4
  type: 'object'
4
- required:
5
- - 'sku'
6
- - 'name'
7
- - 'type'
8
5
  properties:
9
- id:
10
- type: 'uuid'
11
- example: '4550ba8e-5702-4337-bfa6-5e2718468724'
12
- sku:
13
- type: 'string'
14
- example: 'LB-18'
15
- description: 'internal sku code usage or can reuse based on supplier sku code'
16
- brandSku:
17
- type: 'string'
18
- description: 'normally use to reference supplier/brand sku code'
19
- name:
20
- type: 'string'
21
- example: '50PCS PLASTIC LUNCH BOX'
22
- description:
23
- type: 'string'
24
- example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
25
- type:
26
- type: 'string'
27
- example: 'PLASTIC'
28
- brand:
29
- type: 'string'
30
- example: 'COLGATE-PALMOLIVE'
31
- subBrand:
32
- type: 'string'
33
- example: 'COLGATE MINT'
34
- isRequiredCheckExpiry:
35
- type: 'boolean'
36
- pickingStrategy:
37
- type: 'string'
38
- example: 'FIFO'
39
- expirationPeriod:
40
- type: 'integer'
41
- description: 'value should be in days (eg:300 and half day)'
42
- example: 300
43
- auxUnit1:
44
- type: 'string'
45
- description: 'An extra field that is provided for user to set other fields needed to store in product master'
46
- auxValue1:
47
- type: 'string'
48
- description: 'An extra field value that is provided for user to set other fields needed to store in product master'
49
- auxUnit2:
50
- type: 'string'
51
- description: 'An extra field that is provided for user to set other fields needed to store in product master'
52
- auxValue2:
53
- type: 'string'
54
- description: 'An extra field value that is provided for user to set other fields needed to store in product master'
55
- auxUnit3:
56
- type: 'string'
57
- description: 'An extra field that is provided for user to set other fields needed to store in product master'
58
- auxValue3:
59
- type: 'string'
60
- description: 'An extra field value that is provided for user to set other fields needed to store in product master'
61
- productDetails:
6
+ data:
62
7
  type: 'array'
63
8
  items:
64
- type: 'object'
65
- required:
66
- - 'gtin'
67
- - 'packingType'
68
- - 'packingSize'
69
- - 'uom'
70
- - 'uomValue'
9
+ type:
71
10
  properties:
72
- isDefault:
73
- type: 'boolean'
74
- gtin:
11
+ sku:
75
12
  type: 'string'
76
- description: 'product barcode. fill up with sku code if there is no product barcode'
77
- refCode:
13
+ example: 'LB-18'
14
+ brandSku:
78
15
  type: 'string'
79
- packingType:
16
+ example: 'string'
17
+ name:
80
18
  type: 'string'
81
- example: 'CARTON'
82
- uom:
19
+ example: '50PCS PLASTIC LUNCH BOX'
20
+ description:
83
21
  type: 'string'
84
- example: 'UNIT'
85
- uomValue:
86
- type: 'integer'
87
- format: 'double'
88
- example: 24
89
- packingSize:
90
- type: 'integer'
91
- example: 24
92
- costPrice:
93
- type: 'integer'
94
- format: 'double'
95
- example: 12.50
96
- minQty:
97
- type: 'integer'
98
- maxQty:
99
- type: 'integer'
100
- bufferQty:
101
- type: 'integer'
102
- movement:
22
+ example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
23
+ type:
103
24
  type: 'string'
104
- example: 'FAST'
105
- weightUnit:
25
+ example: 'PLASTIC'
26
+ brand:
106
27
  type: 'string'
107
- example: 'kg'
108
- nettWeight:
109
- type: 'integer'
110
- format: 'double'
111
- example: 20.5
112
- lengthUnit:
28
+ example: 'COLGATE-PALMOLIVE'
29
+ subBrand:
113
30
  type: 'string'
114
- example: 'cm'
115
- width:
116
- type: 'integer'
117
- format: 'double'
118
- example: 10.5
119
- depth:
120
- type: 'integer'
121
- format: 'double'
122
- example: 2.00
123
- height:
124
- type: 'integer'
125
- format: 'double'
126
- example: 4.00
127
- volume:
31
+ example: 'COLGATE MINT'
32
+ isRequiredCheckExpiry:
33
+ type: 'boolean'
34
+ example: true
35
+ isRequireSerialNumberScanning:
36
+ type: 'boolean'
37
+ example: true
38
+ isRequireSerialNumberScanningInbound:
39
+ type: 'boolean'
40
+ example: true
41
+ isRequireSerialNumberScanningOutbound:
42
+ type: 'boolean'
43
+ example: true
44
+ pickingStrategy:
45
+ type: 'string'
46
+ example: 'FIFO'
47
+ expirationPeriod:
128
48
  type: 'integer'
129
- format: 'double'
130
- example: 6.00
131
- auxUnit1:
49
+ description: 'value should be in days (eg:300 and half day)'
50
+ example: 300
51
+ productDetails:
52
+ type: 'array'
53
+ items:
54
+ type: 'object'
55
+ properties:
56
+ isDefault:
57
+ type: 'boolean'
58
+ example: true
59
+ gtin:
60
+ type: 'string'
61
+ example: 'string'
62
+ refCode:
63
+ type: 'string'
64
+ example: 'string'
65
+ packingType:
66
+ type: 'string'
67
+ example: 'CARTON'
68
+ packingSize:
69
+ type: 'integer'
70
+ format: 'double'
71
+ example: 24
72
+ uom:
73
+ type: 'string'
74
+ example: 'UNIT'
75
+ uomValue:
76
+ type: 'integer'
77
+ format: 'double'
78
+ example: 24
79
+ costPrice:
80
+ type: 'integer'
81
+ format: 'double'
82
+ example: 12.50
83
+ minQty:
84
+ type: 'integer'
85
+ example: 0
86
+ maxQty:
87
+ type: 'integer'
88
+ example: 0
89
+ bufferQty:
90
+ type: 'integer'
91
+ example: 0
92
+ movement:
93
+ type: 'string'
94
+ example: 'normal'
95
+ weightUnit:
96
+ type: 'string'
97
+ example: 'kg'
98
+ nettWeight:
99
+ type: 'integer'
100
+ format: 'double'
101
+ example: 20.5
102
+ grossWeight:
103
+ type: 'integer'
104
+ format: 'double'
105
+ example: 20.5
106
+ lengthUnit:
107
+ type: 'string'
108
+ example: 'cm'
109
+ width:
110
+ type: 'integer'
111
+ format: 'double'
112
+ example: 10.5
113
+ depth:
114
+ type: 'integer'
115
+ format: 'double'
116
+ example: 2
117
+ height:
118
+ type: 'integer'
119
+ forrmat: 'double'
120
+ example: 4
121
+ volume:
122
+ type: 'integer'
123
+ format: 'double'
124
+ example: 6
125
+ auxUnit1:
126
+ type: 'string'
127
+ example: 'string'
128
+ auxValue1:
129
+ type: 'string'
130
+ example: 'string'
131
+ auxUnit2:
132
+ type: 'string'
133
+ example: 'string'
134
+ auxValue2:
135
+ type: 'string'
136
+ example: 'string'
137
+ auxUnit3:
138
+ type: 'string'
139
+ example: 'string'
140
+ auxValue3:
141
+ type: 'string'
142
+ example: 'string'
143
+ auxUnit4:
144
+ type: 'string'
145
+ example: 'string'
146
+ auxValue4:
147
+ type: 'string'
148
+ example: 'string'
149
+ auxUnit5:
150
+ type: 'string'
151
+ example: 'string'
152
+ auxValue5:
153
+ type: 'string'
154
+ example: 'string'
155
+ childProductDetail:
156
+ type: 'string'
157
+ example: 'string'
158
+ xml:
159
+ name: 'AddProduct'
160
+
161
+ # GetProductList
162
+ GetProductList:
163
+ type: 'object'
164
+ properties:
165
+ data:
166
+ type: 'array'
167
+ items:
168
+ type: 'object'
169
+ properties:
170
+ sku:
132
171
  type: 'string'
133
- description: 'An extra field that is provided for user to set other fields needed to store in product master'
134
- auxValue1:
172
+ example: 'LB-18'
173
+ brandSku:
135
174
  type: 'string'
136
- description: 'An extra field value that is provided for user to set other fields needed to store in product master'
137
- auxUnit2:
175
+ example: 'string'
176
+ name:
138
177
  type: 'string'
139
- description: 'An extra field that is provided for user to set other fields needed to store in product master'
140
- auxValue2:
178
+ example: '50PCS PLASTIC LUNCH BOX'
179
+ description:
141
180
  type: 'string'
142
- description: 'An extra field value that is provided for user to set other fields needed to store in product master'
143
- auxUnit3:
181
+ example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
182
+ type:
144
183
  type: 'string'
145
- description: 'An extra field that is provided for user to set other fields needed to store in product master'
146
- auxValue3:
184
+ example: 'PLASTIC'
185
+ brand:
147
186
  type: 'string'
148
- description: 'An extra field value that is provided for user to set other fields needed to store in product master'
149
- childProductDetail:
187
+ example: 'COLGATE-PALMOLIVE'
188
+ subBrand:
150
189
  type: 'string'
151
- description: 'Fill in GTIN to link among the product details'
190
+ example: 'COLGATE MINT'
191
+ isRequiredCheckExpiry:
192
+ type: 'boolean'
193
+ example: true
194
+ isRequireSerialNumberScanning:
195
+ type: 'boolean'
196
+ example: true
197
+ isRequireSerialNumberScanningInbound:
198
+ type: 'boolean'
199
+ example: true
200
+ isRequireSerialNumberScanningOutbound:
201
+ type: 'boolean'
202
+ example: true
203
+ pickingStrategy:
204
+ type: 'string'
205
+ example: 'FIFO'
206
+ expirationPeriod:
207
+ type: 'integer'
208
+ example: 300
209
+ productDetails:
210
+ type: 'array'
211
+ items:
212
+ type: 'object'
213
+ properties:
214
+ isDefault:
215
+ type: 'boolean'
216
+ example: true
217
+ gtin:
218
+ type: 'string'
219
+ required: true
220
+ example: 'string'
221
+ refCode:
222
+ type: 'string'
223
+ example: 'string'
224
+ packingType:
225
+ type: 'string'
226
+ example: 'CARTON'
227
+ packingSize:
228
+ type: 'integer'
229
+ format: 'double'
230
+ example: 24
231
+ uom:
232
+ type: 'string'
233
+ example: 'UNIT'
234
+ uomValue:
235
+ type: 'integer'
236
+ format: 'double'
237
+ example: 24
238
+ costPrice:
239
+ type: 'integer'
240
+ format: 'double'
241
+ example: 12.5
242
+ minQty:
243
+ type: 'integer'
244
+ example: 0
245
+ maxQty:
246
+ type: 'integer'
247
+ example: 0
248
+ bufferQty:
249
+ type: 'integer'
250
+ example: 0
251
+ movement:
252
+ type: 'string'
253
+ example: 'normal'
254
+ weightUnit:
255
+ type: 'string'
256
+ example: 'kg'
257
+ nettWeight:
258
+ type: 'integer'
259
+ format: 'double'
260
+ example: 20.5
261
+ grossWeight:
262
+ type: 'integer'
263
+ format: 'double'
264
+ example: 20.5
265
+ lengthUnit:
266
+ type: 'string'
267
+ example: 'cm'
268
+ width:
269
+ type: 'integer'
270
+ format: 'double'
271
+ example: 10.5
272
+ depth:
273
+ type: 'integer'
274
+ format: 'double'
275
+ example: 2
276
+ height:
277
+ type: 'integer'
278
+ format: 'double'
279
+ example: 4
280
+ volume:
281
+ type: 'integer'
282
+ format: 'double'
283
+ example: 6
284
+ auxUnit1:
285
+ type: 'string'
286
+ example: 'string'
287
+ auxValue1:
288
+ type: 'string'
289
+ example: 'string'
290
+ auxUnit2:
291
+ type: 'string'
292
+ example: 'string'
293
+ auxValue2:
294
+ type: 'string'
295
+ example: 'string'
296
+ auxUnit3:
297
+ type: 'string'
298
+ example: 'string'
299
+ auxValue3:
300
+ type: 'string'
301
+ example: 'string'
302
+ auxUnit4:
303
+ type: 'string'
304
+ example: 'string'
305
+ auxValue4:
306
+ type: 'string'
307
+ example: 'string'
308
+ auxUnit5:
309
+ type: 'string'
310
+ example: 'string'
311
+ auxValue5:
312
+ type: 'string'
313
+ example: 'string'
314
+ childProductDetail:
315
+ type: 'string'
316
+ example: 'string'
317
+ totalCount:
318
+ type: 'integer'
319
+ example: 1
320
+ limit:
321
+ type: 'integer'
322
+ example: 100
323
+ offset:
324
+ type: 'integer'
325
+ example: 0
152
326
  xml:
153
- name: 'Product'
327
+ name: 'GetProductList'
154
328
 
155
329
  paths:
156
- /warehouse/{warehouseId}/add-products:
330
+ # add-products
331
+ /api/v1/company/add-products:
157
332
  post:
158
333
  tags:
159
- - 'product'
160
- description: 'Use this call to add single or multiple product item.'
334
+ - 'Product'
335
+ summary: 'Add product(s).'
336
+ description: 'Add multiple product. (From Scope we should be able to determine this is for which company).'
161
337
  operationId: 'addProduct'
162
- consumes:
163
- - 'application/json'
164
338
  produces:
165
339
  - 'application/json'
166
340
  parameters:
167
- - in: 'path'
168
- name: 'warehouseId'
169
- required: true
170
- type: 'string'
171
341
  - in: 'body'
172
342
  name: 'body'
173
- description: 'Product object to be added to WMS.'
174
- required: true
175
343
  schema:
176
- type: 'array'
177
- items:
178
- $ref: '#/definitions/Product'
344
+ type: 'object'
345
+ properties:
346
+ data:
347
+ type: 'array'
348
+ items:
349
+ type: 'object'
350
+ require:
351
+ - 'sku'
352
+ - 'name'
353
+ - 'type'
354
+ - 'productDetails'
355
+ properties:
356
+ sku:
357
+ type: 'string'
358
+ required: true
359
+ example: 'LB-18'
360
+ brandSku:
361
+ type: 'string'
362
+ example: 'string'
363
+ name:
364
+ type: 'string'
365
+ required: true
366
+ example: '50PCS PLASTIC LUNCH BOX'
367
+ description:
368
+ type: 'string'
369
+ example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
370
+ type:
371
+ type: 'string'
372
+ required: true
373
+ example: 'PLASTIC'
374
+ brand:
375
+ type: 'string'
376
+ example: 'COLGATE-PALMOLIVE'
377
+ subBrand:
378
+ type: 'string'
379
+ example: 'COLGATE MINT'
380
+ isRequiredCheckExpiry:
381
+ type: 'boolean'
382
+ example: true
383
+ isRequireSerialNumberScanning:
384
+ type: 'boolean'
385
+ example: true
386
+ isRequireSerialNumberScanningInbound:
387
+ type: 'boolean'
388
+ example: true
389
+ isRequireSerialNumberScanningOutbound:
390
+ type: 'boolean'
391
+ example: true
392
+ pickingStrategy:
393
+ type: 'string'
394
+ example: 'FIFO'
395
+ expirationPeriod:
396
+ type: 'integer'
397
+ example: 300
398
+ productDetails:
399
+ type: 'array'
400
+ items:
401
+ type: 'object'
402
+ required:
403
+ - 'isDefault'
404
+ - 'gtin'
405
+ - 'packingType'
406
+ - 'packingSize'
407
+ - 'uom'
408
+ - 'uomValue'
409
+ properties:
410
+ isDefault:
411
+ type: 'boolean'
412
+ required: true
413
+ example: true
414
+ gtin:
415
+ type: 'string'
416
+ required: true
417
+ example: 'string'
418
+ refCode:
419
+ type: 'string'
420
+ example: 'string'
421
+ packingType:
422
+ type: 'string'
423
+ required: true
424
+ example: CARTON
425
+ packingSize:
426
+ type: 'integer'
427
+ required: true
428
+ example: 24
429
+ uom:
430
+ type: 'string'
431
+ required: true
432
+ example: UNIT
433
+ uomValue:
434
+ type: 'integer'
435
+ format: 'double'
436
+ required: true
437
+ example: 24
438
+ costPrice:
439
+ type: 'integer'
440
+ format: 'double'
441
+ example: 12.5
442
+ minQty:
443
+ type: 'integer'
444
+ example: 0
445
+ maxQty:
446
+ type: 'integer'
447
+ example: 0
448
+ bufferQty:
449
+ type: 'integer'
450
+ example: 0
451
+ movement:
452
+ type: 'string'
453
+ example: 'normal'
454
+ weightUnit:
455
+ type: 'string'
456
+ example: 'kg'
457
+ nettWeight:
458
+ type: 'integer'
459
+ format: 'double'
460
+ example: 20.5
461
+ grossWeight:
462
+ type: 'integer'
463
+ format: 'double'
464
+ example: 20.5
465
+ lengthUnit:
466
+ type: 'string'
467
+ example: 'cm'
468
+ width:
469
+ type: 'integer'
470
+ format: 'double'
471
+ example: 10.5
472
+ depth:
473
+ type: 'integer'
474
+ format: 'double'
475
+ example: 2
476
+ height:
477
+ type: 'integer'
478
+ format: 'double'
479
+ example: 4
480
+ volume:
481
+ type: 'integer'
482
+ format: 'double'
483
+ example: 6
484
+ auxUnit1:
485
+ type: 'string'
486
+ example: 'string'
487
+ auxValue1:
488
+ type: 'string'
489
+ example: 'string'
490
+ auxUnit2:
491
+ type: 'string'
492
+ example: 'string'
493
+ auxValue2:
494
+ type: 'string'
495
+ example: 'string'
496
+ auxUnit3:
497
+ type: 'string'
498
+ example: 'string'
499
+ auxValue3:
500
+ type: 'string'
501
+ example: 'string'
502
+ auxUnit4:
503
+ type: 'string'
504
+ example: 'string'
505
+ auxValue4:
506
+ type: 'string'
507
+ example: 'string'
508
+ auxUnit5:
509
+ type: 'string'
510
+ example: 'string'
511
+ auxValue5:
512
+ type: 'string'
513
+ example: 'string'
514
+ childProductDetail:
515
+ type: 'string'
516
+ example: 'string'
179
517
  responses:
180
- '400':
181
- description: 'Bad request is sent'
182
- '401':
183
- description: 'Authentication Error'
184
- '404':
185
- description: 'Resource not found'
186
- '500':
187
- description: 'Server error'
188
- /warehouse/{warehouseId}/get-products:
518
+ '200':
519
+ description: 'success'
520
+ content:
521
+ application/json:
522
+ schema:
523
+ type: 'array'
524
+ items:
525
+ $ref: '#/definitions/AddProduct'
526
+ # get-product-list
527
+ /api/v1/company/get-product-list:
189
528
  get:
190
529
  tags:
191
- - 'product'
192
- description: 'Use this API to get a list of products from wms.'
193
- operationId: 'getProduct'
530
+ - 'Product'
531
+ summary: 'Get list of product(s)'
532
+ description: 'Get list of product. Specify bizplace that is within this company.'
533
+ operationId: 'getContactPoint'
194
534
  consumes:
195
535
  - 'application/json'
196
536
  produces:
197
537
  - 'application/json'
198
538
  parameters:
199
- - in: 'path'
200
- name: 'warehouseId'
201
- required: true
539
+ - in: 'query'
540
+ name: 'bizplaceId'
202
541
  type: 'string'
542
+ description: 'Required to specify the bizplace to search.'
543
+ required: true
203
544
  - in: 'query'
204
545
  name: 'skuId'
205
546
  type: 'string'
206
547
  - in: 'query'
207
- name: 'paginationEntriesPerPage'
208
- description: 'This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.'
548
+ name: 'limit'
209
549
  type: 'integer'
210
- format: 'uint32'
550
+ default: 100
551
+ max: 100
211
552
  - in: 'query'
212
- name: 'paginationOffset'
213
- description: 'Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.'
553
+ name: 'offset'
214
554
  type: 'integer'
215
- format: 'uint32'
555
+ default: 0
216
556
  responses:
217
557
  '200':
218
558
  description: 'successful operation'
@@ -221,12 +561,4 @@ paths:
221
561
  schema:
222
562
  type: 'array'
223
563
  items:
224
- $ref: '#/definitions/Product'
225
- '400':
226
- description: 'Bad request is sent'
227
- '401':
228
- description: 'Authentication Error'
229
- '404':
230
- description: 'Resource not found'
231
- '500':
232
- description: 'Server error'
564
+ $ref: '#/definitions/GetProductList'