@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/inbound.yaml CHANGED
@@ -1,308 +1,644 @@
1
1
  definitions:
2
- GRN:
2
+ # AddInboundOrder
3
+ AddInboundOrder:
3
4
  type: 'object'
4
5
  properties:
5
- result:
6
+ data:
6
7
  type: 'object'
7
8
  properties:
8
- goodsReceivalNotes:
9
- type: 'object'
10
- properties:
11
- items:
12
- type: 'array'
13
- items:
9
+ id:
10
+ type: 'string'
11
+ example: 1d61cd39-f9de-4a28-8d24-981e6ea5c626
12
+ ganNo:
13
+ type: 'string'
14
+ example: 'xxxxxxx'
15
+ refNo:
16
+ type: 'string'
17
+ example: 'reference doc 1'
18
+ refNo2:
19
+ type: 'string'
20
+ example: 'reference doc 2'
21
+ refNo3:
22
+ type: 'string'
23
+ example: 'reference doc 3'
24
+ etaDate:
25
+ type: 'string'
26
+ example: '2019-10-31'
27
+ ownTransport:
28
+ type: 'boolean'
29
+ example: false
30
+ importCargo:
31
+ type: 'boolean'
32
+ example: false
33
+ container:
34
+ type: 'boolean'
35
+ example: false
36
+ truckNo:
37
+ type: 'string'
38
+ example: 'ANN1020'
39
+ deliveryOrderNo:
40
+ type: 'string'
41
+ example: 'DO1905739'
42
+ containerNo:
43
+ type: 'string'
44
+ example: 'TEM10203'
45
+ containerSize:
46
+ type: 'string'
47
+ example: '5 tonnes'
48
+ orderProducts:
49
+ type: 'array'
50
+ items:
51
+ type: 'object'
52
+ properties:
53
+ product:
14
54
  type: 'object'
15
55
  properties:
16
- id:
17
- type: 'string'
18
- example: '7347f0de-127d-473a-a103-00a086dd67be'
19
- name:
20
- type: 'string'
21
- example: 'GRN-2022225847648'
22
- refNo:
56
+ sku:
23
57
  type: 'string'
24
- example: 'GAN-202222571720651'
25
- description:
58
+ example: '00F8Y6'
59
+ uom:
26
60
  type: 'string'
27
- example: null
28
- customerStatus:
29
- type: 'string'
30
- example: null
31
- status:
32
- type: 'string'
33
- example: 'PENDING_RECEIVE'
34
- domain:
35
- type: 'object'
36
- properties:
37
- id:
38
- type: 'string'
39
- example: 'df6dba81-6029-4f95-96ff-748570dc2f4e'
40
- name:
41
- type: 'string'
42
- example: 'ABC Warehouse'
43
- arrivalNotice:
44
- type: 'object'
45
- properties:
46
- id:
47
- type: 'string'
48
- example: '33db4bbe-f652-440b-9c36-13af627d3989'
49
- name:
50
- type: 'string'
51
- example: 'GAN-202222572720659'
52
- description:
53
- type: 'string'
54
- example: null
55
- status:
56
- type: 'string'
57
- example: 'DONE'
58
- refNo:
59
- type: 'string'
60
- example: 'ABC Transportation - 3 Ton'
61
- refNo2:
62
- type: 'string'
63
- example: 'Loose'
64
- refNo3:
65
- type: 'string'
66
- example: null
67
- orderProducts:
68
- type: 'object'
69
- properties:
70
- id:
71
- type: 'string'
72
- example: 'b6e18590-4876-4cf4-87af-3c53f7c623d1'
73
- type:
74
- type: 'string'
75
- example: null
76
- batchId:
77
- type: 'string'
78
- example: '-'
79
- packingType:
80
- type: 'string'
81
- example: 'CARTON'
82
- packingSize:
83
- type: 'number'
84
- example: 24
85
- releaseQty:
86
- type: 'number'
87
- example: null
88
- releaseUomValue:
89
- type: 'number'
90
- example: null
91
- status:
92
- type: 'string'
93
- example: 'ACTIVE'
94
- bizplace:
95
- type: 'object'
96
- properties:
97
- id:
98
- type: 'string'
99
- example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
100
- name:
101
- type: 'string'
102
- example: 'ABC E-commerce'
103
- description:
104
- type: 'string'
105
- example: ''
106
- attachments:
107
- type: 'string'
108
- example: ''
109
- createdAt:
110
- type: 'number'
111
- example: 1645750026391
112
- updatedAt:
113
- type: 'number'
114
- example: 1645750026391
115
- updater:
116
- type: 'object'
117
- properties:
118
- id:
119
- type: 'string'
120
- example: '2ce54c66-436a-40cf-a042-24d032c28ceb'
121
- name:
122
- type: 'string'
123
- example: 'Ee Chern Hao'
124
- description:
125
- type: 'string'
126
- example: null
127
- total:
128
- type: 'number'
129
- example: 12
61
+ example: 'UNIT'
62
+ uomValue:
63
+ type: 'integer'
64
+ format: 'double'
65
+ example: 24
66
+ batchId:
67
+ type: 'string'
68
+ example: 'batch no 1'
69
+ packingType:
70
+ type: 'string'
71
+ example: 'CARTON'
72
+ packingSize:
73
+ type: 'integer'
74
+ example: 24
75
+ packQty:
76
+ type: 'integer'
77
+ example: 1
78
+ palletQty:
79
+ type: 'integer'
80
+ example: 1
81
+ supplier:
82
+ type: 'object'
83
+ properties:
84
+ name:
85
+ type: 'string'
86
+ example: 'Supplier A'
87
+ companyName:
88
+ type: 'string'
89
+ example: 'Supplier Company A'
90
+ email:
91
+ type: 'string'
92
+ example: 'email@companyA.com'
93
+ accountNo:
94
+ type: 'string'
95
+ example: 'COMPANY-ACODE'
130
96
  xml:
131
- name: 'GRN'
132
- Inbound:
97
+ name: 'AddInboundOrder'
98
+
99
+ # CancelInboundOrder
100
+ CancelInboundOrder:
133
101
  type: 'object'
134
- required:
135
- - 'etaDate'
136
- - 'orderProducts'
137
102
  properties:
138
- refNo:
139
- type: 'string'
140
- example: 'reference doc 1'
141
- refNo2:
142
- type: 'string'
143
- example: 'reference doc 2'
144
- refNo3:
145
- type: 'string'
146
- example: 'reference doc 3'
147
- etaDate:
148
- type: 'string'
149
- example: '2019-10-31'
150
- ownTransport:
151
- type: 'boolean'
152
- default: false
153
- importCargo:
154
- type: 'boolean'
155
- default: false
156
- container:
157
- type: 'boolean'
158
- default: false
159
- truckNo:
160
- type: 'string'
161
- example: 'ANN1020'
162
- deliveryOrderNo:
163
- type: 'string'
164
- example: 'DO1905739'
165
- containerNo:
166
- type: 'string'
167
- example: 'TEM10203'
168
- containerSize:
169
- type: 'string'
170
- example: '5 tonnes'
171
- orderProducts:
103
+ data:
104
+ type: 'object'
105
+ properties:
106
+ ganNo:
107
+ type: 'string'
108
+ example: 'xxxxx'
109
+ xml:
110
+ name: 'CancelInboundOrder'
111
+
112
+ # GetInboundOrderList
113
+ GetInboundOrderList:
114
+ type: 'object'
115
+ properties:
116
+ data:
172
117
  type: 'array'
173
118
  items:
174
119
  type: 'object'
175
- required:
176
- - 'sku'
177
- - 'packingType'
178
- - 'batchId'
179
- - 'packQty'
180
120
  properties:
181
- products:
121
+ id:
122
+ type: 'string'
123
+ example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
124
+ ganNo:
125
+ type: 'string'
126
+ example: 'xxxxxx'
127
+ refNo:
128
+ type: 'string'
129
+ example: 'reference doc 1'
130
+ refNo2:
131
+ type: 'string'
132
+ example: 'reference doc 2'
133
+ refNo3:
134
+ type: 'string'
135
+ example: 'reference doc 3'
136
+ etaDate:
137
+ type: 'string'
138
+ example: '2019-10-31'
139
+ ownTransport:
140
+ type: 'boolean'
141
+ example: false
142
+ importCargo:
143
+ type: 'boolean'
144
+ example: false
145
+ container:
146
+ type: 'boolean'
147
+ example: false
148
+ truckNo:
149
+ type: 'string'
150
+ example: 'ANN1020'
151
+ deliveryOrderNo:
152
+ type: 'string'
153
+ example: 'DO1905739'
154
+ containerNo:
155
+ type: 'string'
156
+ example: 'TEM10203'
157
+ containerSize:
158
+ type: 'string'
159
+ example: '5 tonnes'
160
+ orderProducts:
161
+ type: 'array'
162
+ items:
163
+ type: 'object'
164
+ properties:
165
+ products:
166
+ type: 'object'
167
+ properties:
168
+ sku:
169
+ type: 'string'
170
+ example: '00F8Y6'
171
+ uom:
172
+ type: 'string'
173
+ example: 'UNIT'
174
+ uomValue:
175
+ type: 'integer'
176
+ format: 'double'
177
+ example: 24
178
+ batchId:
179
+ type: 'string'
180
+ example: 'batch no 1'
181
+ packingType:
182
+ type: 'string'
183
+ example: 'CARTON'
184
+ packingSize:
185
+ type: 'integer'
186
+ example: 24
187
+ packQty:
188
+ type: 'integer'
189
+ example: 1
190
+ palletQty:
191
+ type: 'integer'
192
+ example: 1
193
+ supplier:
182
194
  type: 'object'
183
195
  properties:
184
- sku:
196
+ name:
185
197
  type: 'string'
186
- example: '00F8Y6'
187
- uom:
198
+ example: 'Supplier A'
199
+ companyName:
188
200
  type: 'string'
189
- example: 'UNIT'
190
- uomValue:
191
- type: 'number'
192
- format: 'float'
193
- minimum: 24
194
- batchId:
195
- type: 'string'
196
- description: 'set as dash if no value'
197
- example: 'batch no 1'
198
- packingType:
199
- type: 'string'
200
- example: 'CARTON'
201
- packingSize:
202
- type: 'integer'
203
- description: 'default value is 1'
204
- example: 24
205
- packQty:
206
- type: 'integer'
207
- minimum: 1.0
208
- format: 'int32'
209
- palletQty:
210
- type: 'integer'
211
- minimum: 1.0
212
- format: 'int32'
213
- supplier:
201
+ example: 'Supplier Company A'
202
+ email:
203
+ type: 'string'
204
+ example: 'email@companyA.com'
205
+ accountNo:
206
+ type: 'string'
207
+ example: 'COMPANY-ACODE'
208
+ totalCount:
209
+ type: 'integer'
210
+ example: 35
211
+ limit:
212
+ type: 'integer'
213
+ example: 100
214
+ offset:
215
+ type: 'integer'
216
+ example: 0
217
+ xml:
218
+ name: 'GetInboundOrderList'
219
+
220
+ # GetInboundOrderDetails
221
+ GetInboundOrderDetails:
222
+ type: 'object'
223
+ properties:
224
+ data:
214
225
  type: 'object'
215
- required:
216
- - 'name'
217
- - 'companyName'
218
- - 'email'
219
- - 'accountNo'
220
226
  properties:
221
- name:
227
+ id:
228
+ type: 'string'
229
+ example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
230
+ ganNo:
231
+ type: 'string'
232
+ example: 'xxxxxx'
233
+ refNo:
222
234
  type: 'string'
223
- example: 'Supplier A'
224
- companyName:
235
+ example: 'reference doc 1'
236
+ refNo2:
225
237
  type: 'string'
226
- example: 'Supplier Company A'
227
- email:
238
+ example: 'reference doc 2'
239
+ refNo3:
228
240
  type: 'string'
229
- example: 'email@companyA.com'
230
- accountNo:
241
+ example: 'reference doc 3'
242
+ etaDate:
231
243
  type: 'string'
232
- example: 'COMPANY-ACODE'
244
+ example: '2019-10-31'
245
+ ownTransport:
246
+ type: 'boolean'
247
+ example: false
248
+ importCargo:
249
+ type: 'boolean'
250
+ example: false
251
+ container:
252
+ type: 'boolean'
253
+ example: false
254
+ truckNo:
255
+ type: 'string'
256
+ example: 'ANN1020'
257
+ deliveryOrderNo:
258
+ type: 'string'
259
+ example: 'DO1905739'
260
+ containerNo:
261
+ type: 'string'
262
+ example: 'TEM10203'
263
+ containerSize:
264
+ type: 'string'
265
+ example: '5 tonnes'
266
+ orderProducts:
267
+ type: 'array'
268
+ items:
269
+ type: 'object'
270
+ properties:
271
+ products:
272
+ type: 'object'
273
+ properties:
274
+ sku:
275
+ type: 'string'
276
+ example: '00F8Y6'
277
+ uom:
278
+ type: 'string'
279
+ example: 'UNIT'
280
+ uomValue:
281
+ type: 'integer'
282
+ format: 'double'
283
+ example: 24
284
+ batchId:
285
+ type: 'string'
286
+ example: 'batch no 1'
287
+ packingType:
288
+ type: 'string'
289
+ example: 'CARTON'
290
+ packingSize:
291
+ type: 'integer'
292
+ example: 24
293
+ packQty:
294
+ type: 'integer'
295
+ example: 1
296
+ palletQty:
297
+ type: 'integer'
298
+ example: 1
299
+ supplier:
300
+ type: 'object'
301
+ properties:
302
+ name:
303
+ type: 'string'
304
+ example: 'Supplier A'
305
+ companyName:
306
+ type: 'string'
307
+ example: 'Supplier Company A'
308
+ email:
309
+ type: 'string'
310
+ example: 'email@companyA.com'
311
+ accountNo:
312
+ type: 'string'
313
+ example: 'COMPANY-ACODE'
233
314
  xml:
234
- name: 'Inbound'
315
+ name: 'GetInboundOrderDetails'
316
+
317
+ # GetGoodsReceivedNoteList
318
+ GetGoodsReceivedNoteList:
319
+ type: 'object'
320
+ properties:
321
+ data:
322
+ type: 'array'
323
+ items:
324
+ type: 'object'
325
+ properties:
326
+ id:
327
+ type: 'string'
328
+ example: '7347f0de-127d-473a-a103-00a086dd67be'
329
+ grnNo:
330
+ type: 'string'
331
+ example: 'GRN-2022225847648'
332
+ refNo:
333
+ type: 'string'
334
+ example: 'GAN-202222571720651'
335
+ customerStatus:
336
+ type: 'string'
337
+ example: 'string'
338
+ status:
339
+ type: 'string'
340
+ example: 'PENDING_RECEIVE'
341
+ bizplace:
342
+ type: 'object'
343
+ properties:
344
+ id:
345
+ type: 'string'
346
+ example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
347
+ name:
348
+ type: 'string'
349
+ example: 'ABC E-commerce'
350
+ description:
351
+ type: 'string'
352
+ example: 'string'
353
+ domain:
354
+ type: 'object'
355
+ properties:
356
+ id:
357
+ type: 'string'
358
+ example: 'df6dba81-6029-4f95-96ff-748570dc2f4e'
359
+ name:
360
+ type: 'string'
361
+ example: 'ABC Warehouse'
362
+ arrivalNotice:
363
+ type: 'object'
364
+ properties:
365
+ id:
366
+ type: 'string'
367
+ example: '33db4bbe-f652-440b-9c36-13af627d3989'
368
+ ganNo:
369
+ type: 'string'
370
+ example: 'GAN-202222572720659'
371
+ status:
372
+ type: 'string'
373
+ example: DONE
374
+ refNo:
375
+ type: 'string'
376
+ example: 'ABC Transportation - 3 Ton'
377
+ refNo2:
378
+ type: 'string'
379
+ example: 'Loose'
380
+ refNo3:
381
+ type: 'string'
382
+ example: 'string'
383
+ orderProducts:
384
+ type: 'array'
385
+ items:
386
+ type: 'object'
387
+ properties:
388
+ product:
389
+ type: 'object'
390
+ properties:
391
+ sku:
392
+ type: 'string'
393
+ example: 'string'
394
+ brandSku:
395
+ type: 'string'
396
+ example: 'string'
397
+ name:
398
+ type: 'string'
399
+ example: 'string'
400
+ description:
401
+ type: 'string'
402
+ example: 'string'
403
+ type:
404
+ type: 'string'
405
+ example: 'string'
406
+ batchId:
407
+ type: 'string'
408
+ example: 'string'
409
+ packingType:
410
+ type: 'string'
411
+ example: 'CARTON'
412
+ packingSize:
413
+ type: 'integer'
414
+ example: 24
415
+ releaseQty:
416
+ type: 'integer'
417
+ example: 1
418
+ releaseUomValue:
419
+ type: 'integer'
420
+ format: 'double'
421
+ example: 1
422
+ status:
423
+ type: 'string'
424
+ example: 'ACTIVE'
425
+ attachments:
426
+ type: 'string'
427
+ example: 'string'
428
+ totalCount:
429
+ type: 'integer'
430
+ example: 35
431
+ limit:
432
+ type: 'integer'
433
+ example: 100
434
+ offset:
435
+ type: 'integer'
436
+ example: 0
437
+ xml:
438
+ name: 'GetGoodsReceivedNoteList'
235
439
 
236
440
  paths:
237
- /warehouse/{warehouseId}/add-inbound-order:
441
+ # add-inbound-order
442
+ api/v1/warehouse/add-inbound-order:
238
443
  post:
239
444
  tags:
240
- - 'inbound'
241
- description: 'Use this API to create inbound order in WMS.'
445
+ - 'Inbound'
446
+ summary: 'Add inbound order(s).'
447
+ description: 'Add Inbound Order.'
242
448
  operationId: 'addInboundOrder'
243
449
  produces:
244
450
  - 'application/json'
245
451
  parameters:
246
- - in: 'path'
247
- name: 'warehouseId'
248
- required: true
249
- type: 'string'
250
452
  - in: 'body'
251
453
  name: 'body'
252
- description: 'Inbound order object to be added to WMS.'
253
- required: true
254
454
  schema:
255
- $ref: '#/definitions/Inbound'
455
+ type: 'object'
456
+ properties:
457
+ data:
458
+ type: 'object'
459
+ required:
460
+ - 'bizplaceId'
461
+ - 'etaDate'
462
+ - 'orderProducts'
463
+ properties:
464
+ bizplaceId:
465
+ type: 'string'
466
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
467
+ required: true
468
+ refNo:
469
+ type: 'string'
470
+ example: 'reference doc 1'
471
+ refNo2:
472
+ type: 'string'
473
+ example: 'reference doc 2'
474
+ refNo3:
475
+ type: 'string'
476
+ example: 'reference doc 3'
477
+ etaDate:
478
+ type: 'string'
479
+ example: '2019-10-31'
480
+ required: true
481
+ ownTransport:
482
+ type: 'boolean'
483
+ example: false
484
+ importCargo:
485
+ type: 'boolean'
486
+ example: false
487
+ container:
488
+ type: 'boolean'
489
+ example: false
490
+ truckNo:
491
+ type: 'string'
492
+ example: 'ANN1020'
493
+ deliveryOrderNo:
494
+ type: 'string'
495
+ example: 'DO1905739'
496
+ containerNo:
497
+ type: 'string'
498
+ example: 'TEM10203 //compulsory when container is true'
499
+ containerSize:
500
+ type: 'string'
501
+ example: '5 tonnes //compulsory when container is true'
502
+ supplierId:
503
+ type: 'string'
504
+ example: '69a462c5-9a58-4a61-915d-7ef4c31c8937'
505
+ orderProducts:
506
+ type: 'array'
507
+ items:
508
+ type: 'object'
509
+ required:
510
+ - 'product'
511
+ - 'batchId'
512
+ - 'packQty'
513
+ properties:
514
+ product:
515
+ type: 'object'
516
+ required:
517
+ - 'sku'
518
+ properties:
519
+ sku:
520
+ type: 'string'
521
+ example: '00F8Y6'
522
+ refCode:
523
+ type: 'string'
524
+ example: 'string'
525
+ uom:
526
+ type: 'string'
527
+ example: 'UNIT'
528
+ uomValue:
529
+ type: 'integer'
530
+ format: 'double'
531
+ example: 24
532
+ batchId:
533
+ type: 'string'
534
+ example: 'batch no 1'
535
+ required: true
536
+ packingType:
537
+ type: 'string'
538
+ example: 'CARTON'
539
+ packingSize:
540
+ type: 'integer'
541
+ example: 24
542
+ packQty:
543
+ type: 'integer'
544
+ example: 1
545
+ required: true
546
+ palletQty:
547
+ type: 'integer'
548
+ example: 1
256
549
  responses:
257
550
  '200':
258
- description: 'successful operation'
551
+ description: 'success'
259
552
  content:
260
553
  application/json:
261
554
  schema:
262
- $ref: '#/definitions/Inbound'
263
- '400':
264
- description: 'Bad request is sent'
265
- '401':
266
- description: 'Authentication Error'
267
- '404':
268
- description: 'Resource not found'
269
- '500':
270
- description: 'Server error'
271
- deprecated: false
272
- /warehouse/{warehouseId}/get-inbound-order-list:
555
+ type: 'array'
556
+ items:
557
+ $ref: '#/definitions/AddInboundOrder'
558
+
559
+ # cancel-inbound-order
560
+ api/v1/warehouse/cancel-inbound-order:
561
+ post:
562
+ tags:
563
+ - 'Inbound'
564
+ summary: 'Cancel inbound order(s).'
565
+ description: 'Cancel Inbound Order.'
566
+ operationId: 'cancelInboundOrder'
567
+ produces:
568
+ - 'application/json'
569
+ parameters:
570
+ - in: 'body'
571
+ name: 'body'
572
+ schema:
573
+ type: 'object'
574
+ properties:
575
+ data:
576
+ type: 'object'
577
+ properties:
578
+ bizplaceId:
579
+ type: 'string'
580
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
581
+ required: true
582
+ ganNo:
583
+ type: 'string'
584
+ example: 'xxxxx'
585
+ required: true
586
+ remark:
587
+ type: 'string'
588
+ example: 'reference reference'
589
+ required: true
590
+ responses:
591
+ '200':
592
+ description: 'success'
593
+ content:
594
+ application/json:
595
+ schema:
596
+ type: 'array'
597
+ items:
598
+ $ref: '#/definitions/CancelInboundOrder'
599
+
600
+ # get-inbound-order-list
601
+ api/v1/warehouse/get-inbound-order-list:
273
602
  get:
274
603
  tags:
275
- - 'inbound'
276
- description: 'Use this API to get inbound order from WMS.'
604
+ - 'Inbound'
605
+ summary: 'Get list of inbound order.'
606
+ description: 'Get list of Inbound Order.'
277
607
  operationId: 'getInboundOrderList'
608
+ consumes:
609
+ - 'application/json'
278
610
  produces:
279
611
  - 'application/json'
280
612
  parameters:
281
- - in: 'path'
282
- name: 'warehouseId'
613
+ - in: 'query'
614
+ name: 'bizplaceId'
615
+ type: 'string'
283
616
  required: true
617
+ - in: 'query'
618
+ name: 'ganNo'
284
619
  type: 'string'
285
620
  - in: 'query'
286
621
  name: 'status'
287
622
  type: 'string'
288
623
  - in: 'query'
289
624
  name: 'fromDate'
290
- required: false
291
625
  type: 'string'
626
+ description: '(Must use in conjunction with “toDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
627
+ default: '7 days before current datetime.'
292
628
  - in: 'query'
293
629
  name: 'toDate'
294
- required: false
295
630
  type: 'string'
631
+ description: '(Must use in conjunction with “fromDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
632
+ default: 'Current datetime.'
296
633
  - in: 'query'
297
- name: 'paginationEntriesPerPage'
298
- 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.'
634
+ name: 'limit'
299
635
  type: 'integer'
300
- format: 'uint32'
636
+ default: 100
637
+ max: 100
301
638
  - in: 'query'
302
- name: 'paginationOffset'
303
- 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.'
639
+ name: 'offset'
304
640
  type: 'integer'
305
- format: 'uint32'
641
+ default: 0
306
642
  responses:
307
643
  '200':
308
644
  description: 'successful operation'
@@ -311,95 +647,81 @@ paths:
311
647
  schema:
312
648
  type: 'array'
313
649
  items:
314
- $ref: '#/definitions/Inbound'
315
- '400':
316
- description: 'Bad request is sent'
317
- '401':
318
- description: 'Authentication Error'
319
- '404':
320
- description: 'Resource not found'
321
- '500':
322
- description: 'Server error'
323
- deprecated: false
324
- /warehouse/{warehouseId}/get-inbound-order-detail:
650
+ $ref: '#/definitions/GetInboundOrderList'
651
+
652
+ # get-inbound-order-details
653
+ api/v1/warehouse/get-inbound-order-details:
325
654
  get:
326
655
  tags:
327
- - 'inbound'
328
- description: 'Use this API to get single inbound order detail from WMS.'
329
- operationId: 'getInboundOrderDetail'
656
+ - 'Inbound'
657
+ summary: 'Get inbound order details.'
658
+ description: 'Get Inbound Order Details.'
659
+ operationId: 'getInboundOrderDetails'
660
+ consumes:
661
+ - 'application/json'
330
662
  produces:
331
663
  - 'application/json'
332
664
  parameters:
333
- - in: 'path'
334
- name: 'warehouseId'
335
- required: true
665
+ - in: 'query'
666
+ name: 'bizplaceId'
336
667
  type: 'string'
337
- - name: 'ganNo'
338
- in: 'query'
339
- description: 'The specific inbound order no (arrival notice no).'
340
668
  required: true
669
+ - in: 'query'
670
+ name: 'ganNo'
341
671
  type: 'string'
672
+ required: true
342
673
  responses:
343
674
  '200':
344
675
  description: 'successful operation'
345
676
  content:
346
677
  application/json:
347
678
  schema:
348
- $ref: '#/definitions/Inbound'
349
- '400':
350
- description: 'Bad request is sent'
351
- '401':
352
- description: 'Authentication Error'
353
- '404':
354
- description: 'Resource not found'
355
- '500':
356
- description: 'Server error'
357
- deprecated: false
358
- /warehouse/{warehouseId}/get-goods-received-note:
679
+ type: 'array'
680
+ items:
681
+ $ref: '#/definitions/GetInboundOrderDetails'
682
+
683
+ # get-goods-received-note-list
684
+ api/v1/warehouse/get-goods-received-note-list:
359
685
  get:
360
686
  tags:
361
- - 'inbound'
362
- description: 'Use this API to get a list of goods receival notes from WMS.'
363
- operationId: 'getGoodsReceivedNote'
687
+ - 'Inbound'
688
+ summary: 'Get goods received note list(s).'
689
+ description: 'Get Goods Received Note List.'
690
+ operationId: 'getGoodsReceivedNoteList'
691
+ consumes:
692
+ - 'application/json'
364
693
  produces:
365
694
  - 'application/json'
366
695
  parameters:
367
- - in: 'path'
368
- name: 'warehouseId'
369
- required: true
696
+ - in: 'query'
697
+ name: 'bizplaceId'
370
698
  type: 'string'
371
- - name: 'fromDate'
372
- in: 'query'
373
699
  required: true
700
+ - in: 'query'
701
+ name: 'fromDate'
374
702
  type: 'string'
375
- - name: 'toDate'
376
- in: 'query'
377
- description: 'Maximum date range is 1 month'
378
- required: true
703
+ description: '(Must use in conjunction with “toDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
704
+ default: '7 days before current datetime.'
705
+ - in: 'query'
706
+ name: 'toDate'
379
707
  type: 'string'
380
- - name: 'limit'
381
- in: 'query'
382
- default: 10
383
- required: false
384
- type: 'number'
385
- - name: 'page'
386
- in: 'query'
387
- default: 1
388
- required: false
389
- type: 'number'
708
+ description: '(Must use in conjunction with “fromDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
709
+ default: 'Current datetime.'
710
+ - in: 'query'
711
+ name: 'limit'
712
+ type: 'integer'
713
+ default: 100
714
+ max: 100
715
+ - in: 'query'
716
+ name: 'offset'
717
+ type: 'integer'
718
+ default: 0
390
719
  responses:
391
720
  '200':
392
721
  description: 'successful operation'
393
722
  content:
394
723
  application/json:
395
724
  schema:
396
- $ref: '#/definitions/GRN'
397
- '400':
398
- description: 'Bad request is sent'
399
- '401':
400
- description: 'Authentication Error'
401
- '404':
402
- description: 'Resource not found'
403
- '500':
404
- description: 'Server error'
405
- deprecated: false
725
+ type: 'array'
726
+ items:
727
+ $ref: '#/definitions/GetGoodsReceivedNoteList'