@things-factory/operato-hub 4.1.36 → 4.1.40

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 (7) hide show
  1. package/openapi/unstable/inbound.yaml +178 -0
  2. package/openapi/unstable/outbound.yaml +316 -0
  3. package/openapi/v1/inbound.yaml +178 -0
  4. package/openapi/v1/outbound.yaml +316 -0
  5. package/openapi/v2/inbound.yaml +178 -0
  6. package/openapi/v2/outbound.yaml +316 -0
  7. package/package.json +54 -54
package/openapi/unstable/inbound.yaml CHANGED
@@ -1,4 +1,134 @@
1
1
  definitions:
2
+ GRN:
3
+ type: 'object'
4
+ properties:
5
+ result:
6
+ type: 'object'
7
+ properties:
8
+ goodsReceivalNotes:
9
+ type: 'object'
10
+ properties:
11
+ items:
12
+ type: 'array'
13
+ items:
14
+ type: 'object'
15
+ properties:
16
+ id:
17
+ type: 'string'
18
+ example: '7347f0de-127d-473a-a103-00a086dd67be'
19
+ name:
20
+ type: 'string'
21
+ example: 'GRN-2022225847648'
22
+ refNo:
23
+ type: 'string'
24
+ example: 'GAN-202222571720651'
25
+ description:
26
+ 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
130
+ xml:
131
+ name: 'GRN'
2
132
  Inbound:
3
133
  type: 'object'
4
134
  required:
@@ -225,3 +355,51 @@ paths:
225
355
  '500':
226
356
  description: 'Server error'
227
357
  deprecated: false
358
+ /warehouse/{warehouseId}/get-goods-received-note:
359
+ get:
360
+ tags:
361
+ - 'inbound'
362
+ description: 'Use this API to get a list of goods receival notes from WMS.'
363
+ operationId: 'getGoodsReceivedNote'
364
+ produces:
365
+ - 'application/json'
366
+ parameters:
367
+ - in: 'path'
368
+ name: 'warehouseId'
369
+ required: true
370
+ type: 'string'
371
+ - name: 'fromDate'
372
+ in: 'query'
373
+ required: true
374
+ type: 'string'
375
+ - name: 'toDate'
376
+ in: 'query'
377
+ description: 'Maximum date range is 1 month'
378
+ required: true
379
+ 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'
390
+ responses:
391
+ '200':
392
+ description: 'successful operation'
393
+ content:
394
+ application/json:
395
+ 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
package/openapi/unstable/outbound.yaml CHANGED
@@ -1,4 +1,272 @@
1
1
  definitions:
2
+ DO:
3
+ type: 'object'
4
+ properties:
5
+ result:
6
+ type: 'object'
7
+ properties:
8
+ deliveryOrders:
9
+ type: 'object'
10
+ properties:
11
+ items:
12
+ type: 'array'
13
+ items:
14
+ type: 'object'
15
+ properties:
16
+ name:
17
+ type: 'string'
18
+ example: 'DO-202193085211820'
19
+ from:
20
+ type: 'string'
21
+ example: null
22
+ to:
23
+ type: 'string'
24
+ example: null
25
+ contactPointRefId:
26
+ type: 'string'
27
+ example: null
28
+ truckNo:
29
+ type: 'string'
30
+ example: null
31
+ deliveryDate:
32
+ type: 'string'
33
+ example: null
34
+ status:
35
+ type: 'string'
36
+ example: 'READY_TO_DISPATCH'
37
+ ownCollection:
38
+ type: 'boolean'
39
+ example: true
40
+ looseItem:
41
+ type: 'string'
42
+ example: null
43
+ deliveryDateTime:
44
+ type: 'string'
45
+ example: null
46
+ loadWeight:
47
+ type: 'string'
48
+ example: null
49
+ cargoType:
50
+ type: 'string'
51
+ example: null
52
+ urgency:
53
+ type: 'string'
54
+ example: null
55
+ telNo:
56
+ type: 'string'
57
+ example: null
58
+ refNo:
59
+ type: 'string'
60
+ example: '2675858675687'
61
+ otherDriver:
62
+ type: 'string'
63
+ example: null
64
+ palletQty:
65
+ type: 'number'
66
+ example: null
67
+ remark:
68
+ type: 'string'
69
+ example: null
70
+ description:
71
+ type: 'number'
72
+ example: null
73
+ reusablePallet:
74
+ type: 'string'
75
+ example: null
76
+ domain:
77
+ type: 'object'
78
+ properties:
79
+ name:
80
+ type: 'string'
81
+ example: 'ABC Warehouse'
82
+ bizplace:
83
+ type: 'object'
84
+ properties:
85
+ name:
86
+ type: 'string'
87
+ example: 'ABC E-commerce'
88
+ releaseGood:
89
+ type: 'object'
90
+ properties:
91
+ name:
92
+ type: 'string'
93
+ example: 'RO-20219317281764'
94
+ description:
95
+ type: 'string'
96
+ example: null
97
+ status:
98
+ type: 'string'
99
+ example: 'DONE'
100
+ refNo:
101
+ type: 'string'
102
+ example: '678968687688967'
103
+ refNo2:
104
+ type: 'string'
105
+ example: 'Loose'
106
+ refNo3:
107
+ type: 'string'
108
+ example: null
109
+ truckNo:
110
+ type: 'string'
111
+ example: null
112
+ exportOption:
113
+ type: 'boolean'
114
+ example: false
115
+ ownTransport:
116
+ type: 'boolean'
117
+ example: true
118
+ crossDocking:
119
+ type: 'boolean'
120
+ example: false
121
+ releaseDateTime:
122
+ type: 'string'
123
+ example: null
124
+ releaseDate:
125
+ type: 'string'
126
+ example: '2021-09-09'
127
+ remark:
128
+ type: 'string'
129
+ example: null
130
+ courierOption:
131
+ type: 'boolean'
132
+ example: false
133
+ packingOption:
134
+ type: 'boolean'
135
+ example: false
136
+ type:
137
+ type: 'boolean'
138
+ example: 'b2b'
139
+ acceptedAt:
140
+ type: 'number'
141
+ example: 1632958100650
142
+ marketplaceOrderStatus:
143
+ type: 'string'
144
+ example: null
145
+ billingAddress:
146
+ type: 'string'
147
+ example: null
148
+ deliveryAddress1:
149
+ type: 'string'
150
+ example: null
151
+ deliveryAddress2:
152
+ type: 'string'
153
+ example: null
154
+ deliveryAddress3:
155
+ type: 'string'
156
+ example: null
157
+ deliveryAddress4:
158
+ type: 'string'
159
+ example: null
160
+ deliveryAddress5:
161
+ type: 'string'
162
+ example: null
163
+ attentionTo:
164
+ type: 'string'
165
+ example: null
166
+ attentionCompany:
167
+ type: 'string'
168
+ example: null
169
+ city:
170
+ type: 'string'
171
+ example: null
172
+ state:
173
+ type: 'string'
174
+ example: null
175
+ postalCode:
176
+ type: 'string'
177
+ example: null
178
+ country:
179
+ type: 'string'
180
+ example: null
181
+ phone1:
182
+ type: 'string'
183
+ example: null
184
+ phone2:
185
+ type: 'string'
186
+ example: null
187
+ email:
188
+ type: 'string'
189
+ example: null
190
+ transporter:
191
+ type: 'string'
192
+ example: 'Others (West Malaysia)'
193
+ trackingNo:
194
+ type: 'string'
195
+ example: null
196
+ airwayBill:
197
+ type: 'string'
198
+ example: null
199
+ invoice:
200
+ type: 'string'
201
+ example: null
202
+ pickupAddress:
203
+ type: 'string'
204
+ example: null
205
+ pickupTime:
206
+ type: 'string'
207
+ example: null
208
+ handoverType:
209
+ type: 'string'
210
+ example: null
211
+ dropoffAddress:
212
+ type: 'string'
213
+ example: null
214
+ noOfItems:
215
+ type: 'string'
216
+ example: null
217
+ orderProducts:
218
+ type: 'object'
219
+ properties:
220
+ id:
221
+ type: 'string'
222
+ example: 'b6e18590-4876-4cf4-87af-3c53f7c623d1'
223
+ type:
224
+ type: 'string'
225
+ example: null
226
+ batchId:
227
+ type: 'string'
228
+ example: '-'
229
+ packingType:
230
+ type: 'string'
231
+ example: 'CARTON'
232
+ packingSize:
233
+ type: 'number'
234
+ example: 24
235
+ releaseQty:
236
+ type: 'number'
237
+ example: null
238
+ releaseUomValue:
239
+ type: 'number'
240
+ example: null
241
+ status:
242
+ type: 'string'
243
+ example: 'ACTIVE'
244
+ attachments:
245
+ type: 'string'
246
+ example: ''
247
+ createdAt:
248
+ type: 'number'
249
+ example: 1645750026391
250
+ updatedAt:
251
+ type: 'number'
252
+ example: 1645750026391
253
+ updater:
254
+ type: 'object'
255
+ properties:
256
+ id:
257
+ type: 'string'
258
+ example: '2ce54c66-436a-40cf-a042-24d032c28ceb'
259
+ name:
260
+ type: 'string'
261
+ example: 'Ee Chern Hao'
262
+ description:
263
+ type: 'string'
264
+ example: null
265
+ total:
266
+ type: 'number'
267
+ example: 12
268
+ xml:
269
+ name: 'DO'
2
270
  Outbound:
3
271
  type: 'object'
4
272
  required:
@@ -361,3 +629,51 @@ paths:
361
629
  '500':
362
630
  description: 'Server error'
363
631
  deprecated: false
632
+ /warehouse/{warehouseId}/get-delivery-orders:
633
+ get:
634
+ tags:
635
+ - 'outbound'
636
+ description: 'Use this API to get a list of delivery orders from WMS.'
637
+ operationId: 'getDeliveryOrder'
638
+ produces:
639
+ - 'application/json'
640
+ parameters:
641
+ - in: 'path'
642
+ name: 'warehouseId'
643
+ required: true
644
+ type: 'string'
645
+ - name: 'fromDate'
646
+ in: 'query'
647
+ required: true
648
+ type: 'string'
649
+ - name: 'toDate'
650
+ in: 'query'
651
+ description: 'Maximum date range is 1 month'
652
+ required: true
653
+ type: 'string'
654
+ - name: 'limit'
655
+ in: 'query'
656
+ default: 10
657
+ required: false
658
+ type: 'number'
659
+ - name: 'page'
660
+ in: 'query'
661
+ default: 1
662
+ required: false
663
+ type: 'number'
664
+ responses:
665
+ '200':
666
+ description: 'successful operation'
667
+ content:
668
+ application/json:
669
+ schema:
670
+ $ref: '#/definitions/DO'
671
+ '400':
672
+ description: 'Bad request is sent'
673
+ '401':
674
+ description: 'Authentication Error'
675
+ '404':
676
+ description: 'Resource not found'
677
+ '500':
678
+ description: 'Server error'
679
+ deprecated: false
package/openapi/v1/inbound.yaml CHANGED
@@ -1,4 +1,134 @@
1
1
  definitions:
2
+ GRN:
3
+ type: 'object'
4
+ properties:
5
+ result:
6
+ type: 'object'
7
+ properties:
8
+ goodsReceivalNotes:
9
+ type: 'object'
10
+ properties:
11
+ items:
12
+ type: 'array'
13
+ items:
14
+ type: 'object'
15
+ properties:
16
+ id:
17
+ type: 'string'
18
+ example: '7347f0de-127d-473a-a103-00a086dd67be'
19
+ name:
20
+ type: 'string'
21
+ example: 'GRN-2022225847648'
22
+ refNo:
23
+ type: 'string'
24
+ example: 'GAN-202222571720651'
25
+ description:
26
+ 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
130
+ xml:
131
+ name: 'GRN'
2
132
  Inbound:
3
133
  type: 'object'
4
134
  required:
@@ -225,3 +355,51 @@ paths:
225
355
  '500':
226
356
  description: 'Server error'
227
357
  deprecated: false
358
+ /warehouse/{warehouseId}/get-goods-received-note:
359
+ get:
360
+ tags:
361
+ - 'inbound'
362
+ description: 'Use this API to get a list of goods receival notes from WMS.'
363
+ operationId: 'getGoodsReceivedNote'
364
+ produces:
365
+ - 'application/json'
366
+ parameters:
367
+ - in: 'path'
368
+ name: 'warehouseId'
369
+ required: true
370
+ type: 'string'
371
+ - name: 'fromDate'
372
+ in: 'query'
373
+ required: true
374
+ type: 'string'
375
+ - name: 'toDate'
376
+ in: 'query'
377
+ description: 'Maximum date range is 1 month'
378
+ required: true
379
+ 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'
390
+ responses:
391
+ '200':
392
+ description: 'successful operation'
393
+ content:
394
+ application/json:
395
+ 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