@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.
@@ -1,606 +1,1359 @@
1
1
  definitions:
2
- DO:
2
+ # AddReleaseOrder
3
+ AddReleaseOrder:
3
4
  type: 'object'
4
- properties:
5
- result:
5
+ properties:
6
+ data:
6
7
  type: 'object'
7
8
  properties:
8
- deliveryOrders:
9
+ id:
10
+ type: 'string'
11
+ example: 'd4065b22-b002-4fdd-94c1-6df7a2d36fed'
12
+ roNo:
13
+ type: 'string'
14
+ example: 'RO-2022710116761'
15
+ refNo:
16
+ type: 'string'
17
+ example: '2206308RFYKUCV'
18
+ refNo2:
19
+ type: 'string'
20
+ example: '2206308RFYKUCV'
21
+ refNo3:
22
+ type: 'string'
23
+ example: 'string'
24
+ status:
25
+ type: 'string'
26
+ example: 'PENDING_WORKSHEET'
27
+ truckNo:
28
+ type: 'string'
29
+ example: 'string'
30
+ ownTransport:
31
+ type: 'boolean'
32
+ example: true
33
+ crossDocking:
34
+ type: 'boolean'
35
+ example: false
36
+ marketplaceOrderStatus:
37
+ type: 'string'
38
+ example: 'ready_to_ship'
39
+ billingAddress:
40
+ type: 'string'
41
+ example: 'string'
42
+ deliveryAddress1:
43
+ type: 'string'
44
+ example: 'No 14 Lorong 9A Tman Peruda Fasa 1B Kuala Muda 08000 Kedah'
45
+ deliveryAddress2:
46
+ type: 'string'
47
+ example: 'string'
48
+ deliveryAddress3:
49
+ type: 'string'
50
+ example: 'string'
51
+ deliveryAddress4:
52
+ type: 'string'
53
+ example: 'string'
54
+ deliveryAddress5:
55
+ type: 'string'
56
+ example: 'string'
57
+ attentionTo:
58
+ type: 'string'
59
+ example: 'Rokiah bt Bakar'
60
+ attentionCompany:
61
+ type: 'string'
62
+ example: 'string'
63
+ city:
64
+ type: 'string'
65
+ example: 'Kuala Muda'
66
+ state:
67
+ type: 'string'
68
+ example: 'Kedah'
69
+ postalCode:
70
+ type: 'string'
71
+ example: '08000'
72
+ country:
73
+ type: 'string'
74
+ example: 'Malaysia'
75
+ phone1:
76
+ type: 'string'
77
+ example: '60174396110'
78
+ phone2:
79
+ type: 'string'
80
+ example: 'string'
81
+ email:
82
+ type: 'string'
83
+ example: 'string'
84
+ transporter:
85
+ type: 'string'
86
+ example: 'Others (West Malaysia)'
87
+ trackingNo:
88
+ type: 'string'
89
+ example: 'SBOP220701000290101'
90
+ airwayBill:
91
+ type: 'string'
92
+ example: 'string'
93
+ invoice:
94
+ type: 'string'
95
+ example: 'string'
96
+ type:
97
+ type: 'string'
98
+ enum: [b2c,b2b]
99
+ packageId:
100
+ type: 'string'
101
+ example: 'string'
102
+ storeName:
103
+ type: 'string'
104
+ example: 'string'
105
+ storeId:
106
+ type: 'string'
107
+ example: 'string'
108
+ routeId:
109
+ type: 'string'
110
+ example: 'string'
111
+ stopId:
112
+ type: 'string'
113
+ example: 'string'
114
+ exportOption:
115
+ type: 'boolean'
116
+ example: false
117
+ releaseDate:
118
+ type: 'string'
119
+ example: '2022-07-01'
120
+ collectionOrderNo:
121
+ type: 'string'
122
+ example: '2206308RFYKUCV'
123
+ bizplace:
9
124
  type: 'object'
10
125
  properties:
11
- items:
12
- type: 'array'
13
- items:
126
+ name:
127
+ type: 'string'
128
+ example: 'FNBM E-commerce'
129
+ domain:
130
+ type: 'object'
131
+ properties:
132
+ name:
133
+ type: 'string'
134
+ example: 'SeeBuu Warehouse'
135
+ orderInventories:
136
+ type: 'array'
137
+ items:
138
+ type: 'object'
139
+ properties:
140
+ product:
14
141
  type: 'object'
15
142
  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:
143
+ name:
53
144
  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:
145
+ example: 'SS ROSE SOYA (A) ASP 1L X 12'
146
+ sku:
245
147
  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
148
+ example: '1172790'
149
+ batchId:
150
+ type: 'string'
151
+ example: '11/2023'
152
+ packingType:
153
+ type: 'string'
154
+ example: 'CARTON'
155
+ packingSize:
156
+ type: 'integer'
157
+ format: 'double'
158
+ example: 1
159
+ releaseQty:
160
+ type: 'integer'
161
+ example: 1
162
+ releaseUomValue:
163
+ type: 'integer'
164
+ example: 12
268
165
  xml:
269
- name: 'DO'
270
- Outbound:
166
+ name: 'AddReleaseOrder'
167
+
168
+ # CancelReleaseOrder
169
+ CancelReleaseOrder:
271
170
  type: 'object'
272
- required:
273
- - 'releaseDate'
274
- - 'orderInventories'
275
- properties:
276
- id:
277
- type: 'uuid'
278
- example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
279
- refNo:
280
- type: 'string'
281
- example: 'INV-0001'
282
- refNo1:
283
- type: 'string'
284
- example: 'INV-0001'
285
- refNo2:
286
- type: 'string'
287
- example: 'INV-0001'
288
- type:
289
- type: 'string'
290
- enum: [b2b, b2c]
291
- releaseDate:
292
- type: 'string'
293
- example: '2019-10-31'
294
- collectionOrderNo:
295
- type: 'string'
296
- example: 'CO-2020219301'
297
- ownTransport:
298
- type: 'boolean'
299
- default: false
300
- exportOption:
301
- type: 'boolean'
302
- default: false
303
- transporter:
304
- type: 'string'
305
- example: 'DHL eCommerce'
306
- trackingNo:
307
- type: 'string'
308
- example: 'TA-2220100301'
309
- marketplaceOrderStatus:
310
- type: 'string'
311
- example: 'Ready To Ship'
312
- airwayBill:
313
- type: 'string'
314
- example: 'https://pdfurl.com'
315
- invoice:
316
- type: 'string'
317
- example: 'https://pdfurl.com'
318
- storeName:
319
- type: 'string'
320
- example: 'Demo Store'
321
- storeId:
322
- type: 'string'
323
- example: '1949'
324
- routeId:
325
- type: 'string'
326
- example: 'CTR-07'
327
- stopId:
328
- type: 'string'
329
- example: '24'
330
- billTo:
171
+ properties:
172
+ data:
331
173
  type: 'object'
332
174
  properties:
333
- billingAddress:
175
+ ro:
334
176
  type: 'string'
335
- example: '36, Jalan Kerongsang 2, Bandar Puteri Klang,Selangor, Klang, 41200 Malaysia'
336
- deliverTo:
177
+ example: 'xxxxx'
178
+ xml:
179
+ name: 'CancelReleaseOrder'
180
+
181
+ # UpdateReleaseOrderDetails
182
+ UpdateReleaseOrderDetails:
183
+ type: 'object'
184
+ properties:
185
+ data:
337
186
  type: 'object'
338
187
  properties:
339
- deliveryAddress1:
188
+ id:
340
189
  type: 'string'
341
- example: '36, Jalan Kerongsang 2, Bandar Puteri Klang,Selangor, Klang, 41200 Malaysia'
342
- deliveryAddress2:
190
+ example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
191
+ roNo:
343
192
  type: 'string'
344
- example: '-'
345
- deliveryAddress3:
193
+ example: 'xxxxx'
194
+ collectionOrderNo:
346
195
  type: 'string'
347
- example: '-'
348
- deliveryAddress4:
196
+ example: 'string'
197
+ refNo:
349
198
  type: 'string'
350
- example: '-'
351
- deliveryAddress5:
199
+ example: 'string'
200
+ refNo2:
352
201
  type: 'string'
353
- example: '-'
354
- attentionTo:
202
+ example: 'string'
203
+ refNo3:
355
204
  type: 'string'
356
- example: 'Annie'
357
- attentionCompany:
205
+ example: 'string'
206
+ marketplaceOrderStatus:
358
207
  type: 'string'
359
- example: 'ABC SDN BHD'
360
- city:
208
+ example: 'string'
209
+ billingAddress:
361
210
  type: 'string'
362
- example: 'Shah Alam'
363
- state:
211
+ example: 'string'
212
+ deliveryAddress1:
364
213
  type: 'string'
365
- example: 'Selangor'
366
- postalCode:
214
+ example: 'string'
215
+ attentionTo:
367
216
  type: 'string'
368
- example: '41700'
369
- country:
217
+ example: 'string'
218
+ city:
370
219
  type: 'string'
371
- example: 'Malaysia'
372
- phone1:
220
+ example: 'string'
221
+ country:
373
222
  type: 'string'
374
- example: '011-30303030'
375
- phone2:
223
+ example: 'string'
224
+ postalCode:
376
225
  type: 'string'
377
- example: '011-20203030'
378
- email:
226
+ example: 'string'
227
+ phone1:
379
228
  type: 'string'
380
- example: 'abc@hatio.asia'
381
- orderInventories:
229
+ example: 'string'
230
+ transporter:
231
+ type: 'string'
232
+ example: 'string'
233
+ trackingNo:
234
+ type: 'string'
235
+ example: 'string'
236
+ airwayBill:
237
+ type: 'string'
238
+ example: 'string'
239
+ invoice:
240
+ type: 'string'
241
+ example: 'string'
242
+ shippingOrder:
243
+ type: 'object'
244
+ properties:
245
+ shipName:
246
+ type: 'string'
247
+ example: 'string'
248
+ containerNo:
249
+ type: 'string'
250
+ example: 'string'
251
+ loadType:
252
+ type: 'string'
253
+ example: 'string'
254
+ from:
255
+ type: 'string'
256
+ example: 'string'
257
+ to:
258
+ type: 'string'
259
+ example: 'string'
260
+ containerArrivalDate:
261
+ type: 'string'
262
+ example: '2020-02-14'
263
+ containerLeavingDate:
264
+ type: 'string'
265
+ example: '2020-02-14'
266
+ xml:
267
+ name: 'UpdateReleaseOrderDetails'
268
+
269
+ # GetReleaseOrderList
270
+ GetReleaseOrderList:
271
+ type: 'object'
272
+ properties:
273
+ data:
382
274
  type: 'array'
383
275
  items:
384
276
  type: 'object'
385
- required:
386
- - 'sku'
387
- - 'releaseQty'
388
277
  properties:
389
- product:
278
+ id:
279
+ type: 'string'
280
+ example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
281
+ roNo:
282
+ type: 'string'
283
+ example: 'xxxxxx'
284
+ refNo:
285
+ type: 'string'
286
+ example: 'INV-0001'
287
+ refNo2:
288
+ type: 'string'
289
+ example: 'INV-0001'
290
+ refNo3:
291
+ type: 'string'
292
+ example: 'INV-0001'
293
+ type:
294
+ type: 'string'
295
+ enum: [b2b,b2c]
296
+ releaseDate:
297
+ type: 'string'
298
+ example: '2019-10-31'
299
+ collectionOrderNo:
300
+ type: 'string'
301
+ example: 'CO-2020219301'
302
+ ownTransport:
303
+ type: 'boolean'
304
+ example: false
305
+ exportOption:
306
+ type: 'boolean'
307
+ example: false
308
+ transporter:
309
+ type: 'string'
310
+ example: 'DHL eCommerce'
311
+ trackingNo:
312
+ type: 'string'
313
+ example: 'TA-2220100301'
314
+ marketplaceOrderStatus:
315
+ type: 'string'
316
+ example: 'Ready To Ship'
317
+ airwayBill:
318
+ type: 'string'
319
+ example: 'https://pdfurl.com'
320
+ invoice:
321
+ type: 'string'
322
+ example: 'https://pdfurl.com'
323
+ storeName:
324
+ type: 'string'
325
+ example: 'Demo Store'
326
+ storeId:
327
+ type: 'string'
328
+ example: '1949'
329
+ routeId:
330
+ type: 'string'
331
+ example: 'CTR-07'
332
+ stopId:
333
+ type: 'string'
334
+ example: '24'
335
+ billTo:
390
336
  type: 'object'
391
337
  properties:
392
- sku:
393
- type: 'string'
394
- example: 'PANADOL-201020'
395
- refCode:
396
- type: 'string'
397
- example: '201020'
398
- batchId:
399
- type: 'string'
400
- example: 'B374727-1-1-1'
401
- packingType:
402
- type: 'string'
403
- example: 'CARTON'
404
- releaseQty:
405
- type: 'integer'
406
- minimum: 1.0
407
- format: 'int32'
408
- packingSize:
409
- type: 'integer'
410
- format: 'int32'
411
- example: 24
338
+ billingAddress:
339
+ type: 'string'
340
+ example: '36 Jalan Kerongsang 2 Bandar Puteri KlangSelangor Klang 41200 Malaysia '
341
+ deliverTo:
342
+ type: 'object'
343
+ properties:
344
+ deliveryAddress1:
345
+ type: 'string'
346
+ example: '36 Jalan Kerongsang 2 Bandar Puteri KlangSelangor Klang 41200 Malaysia'
347
+ deliveryAddress2:
348
+ type: 'string'
349
+ example: '-'
350
+ deliveryAddress3:
351
+ type: 'string'
352
+ example: '-'
353
+ deliveryAddress4:
354
+ type: 'string'
355
+ example: '-'
356
+ deliveryAddress5:
357
+ type: 'string'
358
+ example: '-'
359
+ attentionTo:
360
+ type: 'string'
361
+ example: 'Annie'
362
+ attentionCompany:
363
+ type: 'string'
364
+ example: 'ABC SDN BHD'
365
+ city:
366
+ type: 'string'
367
+ example: 'Shah Alam'
368
+ state:
369
+ type: 'string'
370
+ example: 'Selangor'
371
+ postalCode:
372
+ type: 'string'
373
+ example: '41700'
374
+ country:
375
+ type: 'string'
376
+ example: 'Malaysia'
377
+ phone1:
378
+ type: 'string'
379
+ example: '011-30303030'
380
+ phone2:
381
+ type: 'string'
382
+ example: '011-20203030'
383
+ email:
384
+ type: 'string'
385
+ example: 'abc@hatio.asia'
386
+ orderInventories:
387
+ type: 'array'
388
+ items:
389
+ type: 'object'
390
+ properties:
391
+ product:
392
+ type: 'object'
393
+ properties:
394
+ sku:
395
+ type: 'string'
396
+ example: 'PANADOL-201020'
397
+ refCode:
398
+ type: 'string'
399
+ example: '201020'
400
+ batchId:
401
+ type: 'string'
402
+ example: 'B374727-1-1-1'
403
+ packingType:
404
+ type: 'string'
405
+ example: 'CARTON'
406
+ releaseQty:
407
+ type: 'integer'
408
+ example: 1
409
+ packingSize:
410
+ type: 'integer'
411
+ example: 24
412
+ totalCount:
413
+ type: 'integer'
414
+ example: 35
415
+ limit:
416
+ type: 'integer'
417
+ example: 100
418
+ offset:
419
+ type: 'integer'
420
+ example: 0
412
421
  xml:
413
- name: 'Outbound'
422
+ name: 'GetReleaseOrderList'
414
423
 
415
- paths:
416
- /warehouse/{warehouseId}/add-release-order:
417
- post:
418
- tags:
419
- - 'outbound'
420
- description: 'Use this API to create release order in WMS.'
421
- operationId: 'addReleaseOrder'
422
- produces:
423
- - 'application/json'
424
- parameters:
425
- - in: 'path'
426
- name: 'warehouseId'
427
- required: true
428
- type: 'string'
429
- - in: 'body'
430
- name: 'body'
431
- description: 'Outbound order object to be added to WMS.'
432
- required: true
433
- schema:
434
- $ref: '#/definitions/Outbound'
435
- responses:
436
- '200':
437
- description: 'successful operation'
438
- '400':
439
- description: 'Bad request is sent'
440
- '401':
441
- description: 'Authentication Error'
442
- '404':
443
- description: 'Resource not found'
444
- '500':
445
- description: 'Server error'
446
- deprecated: false
447
- /warehouse/{warehouseId}/cancel-release-order:
448
- post:
449
- tags:
450
- - 'outbound'
451
- description: 'Set release order in WMS to pending cancellation, warehouse staff will check and confirm the cancellation'
452
- operationId: 'cancelReleaseOrder'
453
- produces:
454
- - 'application/json'
455
- parameters:
456
- - in: 'path'
457
- name: 'warehouseId'
458
- required: true
459
- type: 'string'
460
- - in: 'body'
461
- name: 'body'
462
- required: true
463
- schema:
424
+ # GetReleaseOrderDetails
425
+ GetReleaseOrderDetails:
426
+ type: 'object'
427
+ properties:
428
+ data:
429
+ type: 'object'
430
+ properties:
431
+ id:
432
+ type: 'string'
433
+ example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
434
+ roNo:
435
+ type: 'string'
436
+ example: 'xxxxxx'
437
+ refNo:
438
+ type: 'string'
439
+ example: 'INV-0001'
440
+ refNo1:
441
+ type: 'string'
442
+ example: 'INV-0001'
443
+ refNo2:
444
+ type: 'string'
445
+ example: 'INV-0001'
446
+ type:
447
+ type: 'string'
448
+ enum: [b2b,b2c]
449
+ releaseDate:
450
+ type: 'string'
451
+ example: '2019-10-31'
452
+ collectionOrderNo:
453
+ type: 'string'
454
+ example: 'CO-2020219301'
455
+ ownTransport:
456
+ type: 'boolean'
457
+ example: false
458
+ exportOption:
459
+ type: 'boolean'
460
+ example: false
461
+ transporter:
462
+ type: 'string'
463
+ example: 'DHL eCommerce'
464
+ trackingNo:
465
+ type: 'string'
466
+ example: 'TA-2220100301'
467
+ marketplaceOrderStatus:
468
+ type: 'string'
469
+ example: 'Ready To Ship'
470
+ airwayBill:
471
+ type: 'string'
472
+ example: 'https://pdfurl.com'
473
+ invoice:
474
+ type: 'string'
475
+ example: 'https://pdfurl.com'
476
+ storeName:
477
+ type: 'string'
478
+ example: 'Demo Store'
479
+ storeId:
480
+ type: 'string'
481
+ example: '1949'
482
+ routeId:
483
+ type: 'string'
484
+ example: 'CTR-07'
485
+ stopId:
486
+ type: 'string'
487
+ example: '24'
488
+ billTo:
464
489
  type: 'object'
465
- required:
466
- - orderNo
467
- - remark
468
490
  properties:
469
- orderNo:
491
+ billingAddress:
470
492
  type: 'string'
471
- remark:
493
+ example: '36 Jalan Kerongsang 2 Bandar Puteri KlangSelangor Klang 41200 Malaysia.'
494
+ deliverTo:
495
+ type: 'object'
496
+ properties:
497
+ deliveryAddress1:
472
498
  type: 'string'
473
- responses:
474
- '200':
475
- description: 'Successful Operation'
476
- '400':
477
- description: 'Bad request is sent'
478
- '401':
479
- description: 'Authentication Error'
480
- '404':
481
- description: 'Resource not found'
482
- '500':
483
- description: 'Server error'
484
- deprecated: false
485
- /warehouse/{warehouseId}/update-release-order-details:
499
+ example: '36 Jalan Kerongsang 2 Bandar Puteri KlangSelangor Klang 41200 Malaysia'
500
+ deliveryAddress2:
501
+ type: 'string'
502
+ example: '-'
503
+ deliveryAddress3:
504
+ type: 'string'
505
+ example: '-'
506
+ deliveryAddress4:
507
+ type: 'string'
508
+ example: '-'
509
+ deliveryAddress5:
510
+ type: 'string'
511
+ example: '-'
512
+ attentionTo:
513
+ type: 'string'
514
+ example: 'Annie'
515
+ attentionCompany:
516
+ type: 'string'
517
+ example: 'ABC SDN BHD'
518
+ city:
519
+ type: 'string'
520
+ example: 'Shah Alam'
521
+ state:
522
+ type: 'string'
523
+ example: 'Selangor'
524
+ postalCode:
525
+ type: 'string'
526
+ example: '41700'
527
+ country:
528
+ type: 'string'
529
+ example: 'Malaysia'
530
+ phone1:
531
+ type: 'string'
532
+ example: '011-30303030'
533
+ phone2:
534
+ type: 'string'
535
+ example: '011-20203030'
536
+ email:
537
+ type: 'string'
538
+ example: 'abc@hatio.asia'
539
+ orderInventories:
540
+ type: 'array'
541
+ items:
542
+ type: 'object'
543
+ properties:
544
+ product:
545
+ type: 'object'
546
+ properties:
547
+ sku:
548
+ type: 'string'
549
+ example: 'PANADOL-201020'
550
+ refCode:
551
+ type: 'string'
552
+ example: '201020'
553
+ batchId:
554
+ type: 'string'
555
+ example: 'B374727-1-1-1'
556
+ packingType:
557
+ type: 'string'
558
+ example: 'CARTON'
559
+ releaseQty:
560
+ type: 'integer'
561
+ example: 1
562
+ packingSize:
563
+ type: 'integer'
564
+ example: 24
565
+ xml:
566
+ name: 'GetReleaseOrderDetails'
567
+
568
+ # GetDeliveryOrderList
569
+ GetDeliveryOrderList:
570
+ type: 'object'
571
+ properties:
572
+ data:
573
+ type: 'array'
574
+ items:
575
+ type: 'object'
576
+ properties:
577
+ id:
578
+ type: 'string'
579
+ example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
580
+ doNo:
581
+ type: 'string'
582
+ example: 'DO-202193085211820'
583
+ from:
584
+ type: 'string'
585
+ example: 'string'
586
+ to:
587
+ type: 'string'
588
+ example: 'string'
589
+ contactPointRefId:
590
+ type: 'string'
591
+ example: 'string'
592
+ truckNo:
593
+ type: 'string'
594
+ example: 'string'
595
+ deliveryDate:
596
+ type: 'string'
597
+ example: 'string'
598
+ status:
599
+ type: 'string'
600
+ example: 'READY_TO_DISPATCH'
601
+ ownCollection:
602
+ type: 'boolean'
603
+ example: true
604
+ looseItem:
605
+ type: 'string'
606
+ example: 'string'
607
+ deliveryDateTime:
608
+ type: 'string'
609
+ example: 'string'
610
+ loadWeight:
611
+ type: 'string'
612
+ example: 'string'
613
+ cargoType:
614
+ type: 'string'
615
+ example: 'string'
616
+ urgency:
617
+ type: 'string'
618
+ example: 'string'
619
+ telNo:
620
+ type: 'string'
621
+ example: 'string'
622
+ refNo:
623
+ type: 'string'
624
+ example: '2675858675687'
625
+ otherDriver:
626
+ type: 'string'
627
+ example: 'string'
628
+ palletQty:
629
+ type: 'string'
630
+ example: 'string'
631
+ remark:
632
+ type: 'string'
633
+ example: 'string'
634
+ description:
635
+ type: 'string'
636
+ example: 'string'
637
+ reusablePallet:
638
+ type: 'string'
639
+ example: 'string'
640
+ bizplace:
641
+ type: 'object'
642
+ properties:
643
+ id:
644
+ type: 'string'
645
+ example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
646
+ name:
647
+ type: 'string'
648
+ example: 'ABC E-commerce'
649
+ description:
650
+ type: 'string'
651
+ example: ' '
652
+ domain:
653
+ type: 'object'
654
+ properties:
655
+ id:
656
+ type: 'string'
657
+ example: 'df6dba81-6029-4f95-96ff-748570dc2f4e'
658
+ name:
659
+ type: 'string'
660
+ example: 'ABC Warehouse '
661
+ releaseGood:
662
+ type: 'object'
663
+ properties:
664
+ id:
665
+ type: 'string'
666
+ example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
667
+ roNo:
668
+ type: 'string'
669
+ example: 'RO-20219317281764'
670
+ description:
671
+ type: 'string'
672
+ example: 'string'
673
+ status:
674
+ type: 'string'
675
+ example: 'DONE'
676
+ refNo:
677
+ type: 'string'
678
+ example: '678968687688967'
679
+ refNo2:
680
+ type: 'string'
681
+ example: 'Loose'
682
+ refNo3:
683
+ type: 'string'
684
+ example: 'string'
685
+ truckNo:
686
+ type: 'string'
687
+ example: 'string'
688
+ exportOption:
689
+ type: 'boolean'
690
+ example: false
691
+ ownTransport:
692
+ type: 'boolean'
693
+ example: true
694
+ crossDocking:
695
+ type: 'boolean'
696
+ example: false
697
+ releaseDateTime:
698
+ type: 'string'
699
+ example: 'string'
700
+ releaseDate:
701
+ type: 'string'
702
+ example: '2021-09-09'
703
+ remark:
704
+ type: 'string'
705
+ example: 'string'
706
+ courierOption:
707
+ type: 'boolean'
708
+ example: false
709
+ packingOption:
710
+ type: 'boolean'
711
+ example: false
712
+ type:
713
+ type: 'string'
714
+ enum: [b2b,b2c]
715
+ acceptedAt:
716
+ type: 'string'
717
+ example: '1632958100650'
718
+ marketplaceOrderStatus:
719
+ type: 'string'
720
+ example: 'string'
721
+ billingAddress:
722
+ type: 'string'
723
+ example: 'string'
724
+ deliveryAddress1:
725
+ type: 'string'
726
+ example: 'string'
727
+ deliveryAddress2:
728
+ type: 'string'
729
+ example: 'string'
730
+ deliveryAddress3:
731
+ type: 'string'
732
+ example: 'string'
733
+ deliveryAddress4:
734
+ type: 'string'
735
+ example: 'string'
736
+ deliveryAddress5:
737
+ type: 'string'
738
+ example: 'string'
739
+ attentionTo:
740
+ type: 'string'
741
+ example: 'string'
742
+ attentionCompany:
743
+ type: 'string'
744
+ example: 'string'
745
+ city:
746
+ type: 'string'
747
+ example: 'string'
748
+ state:
749
+ type: 'string'
750
+ example: 'string'
751
+ postalCode:
752
+ type: 'string'
753
+ example: 'string'
754
+ country:
755
+ type: 'string'
756
+ example: 'string'
757
+ phone1:
758
+ type: 'string'
759
+ example: 'string'
760
+ phone2:
761
+ type: 'string'
762
+ example: 'string'
763
+ email:
764
+ type: 'string'
765
+ example: 'string'
766
+ transporter:
767
+ type: 'string'
768
+ example: 'Others (West Malaysia)'
769
+ trackingNo:
770
+ type: 'string'
771
+ example: 'string'
772
+ airwayBill:
773
+ type: 'string'
774
+ example: 'string'
775
+ invoice:
776
+ type: 'string'
777
+ example: 'string'
778
+ pickupAddress:
779
+ type: 'string'
780
+ example: 'string'
781
+ pickupTime:
782
+ type: 'string'
783
+ example: 'string'
784
+ handoverType:
785
+ type: 'string'
786
+ example: 'string'
787
+ dropoffAddress:
788
+ type: 'string'
789
+ example: 'string'
790
+ noOfItems:
791
+ type: 'string'
792
+ example: 'string'
793
+ orderProducts:
794
+ type: 'object'
795
+ properties:
796
+ product:
797
+ type: 'object'
798
+ properties:
799
+ sku:
800
+ type: 'string'
801
+ example: ' '
802
+ brandSku:
803
+ type: 'string'
804
+ example: ' '
805
+ name:
806
+ type: 'string'
807
+ example: ' '
808
+ description:
809
+ type: 'string'
810
+ example: ' '
811
+ type:
812
+ type: 'string'
813
+ example: ' '
814
+ batchId:
815
+ type: 'string'
816
+ example: ' '
817
+ packingType:
818
+ type: 'string'
819
+ example: 'CARTON'
820
+ packingSize:
821
+ type: 'integer'
822
+ format: 'double'
823
+ example: 24
824
+ releaseQty:
825
+ type: 'string'
826
+ example: 'string'
827
+ releaseUomValue:
828
+ type: 'string'
829
+ example: 'string'
830
+ status:
831
+ type: 'string'
832
+ example: 'ACTIVE'
833
+ orderInventories:
834
+ type: 'array'
835
+ items:
836
+ type: 'object'
837
+ properties:
838
+ batchId:
839
+ type: 'string'
840
+ example: '-'
841
+ batchIdRef:
842
+ type: 'string'
843
+ example: ' '
844
+ packingType:
845
+ type: 'string'
846
+ example: ' '
847
+ packingSize:
848
+ type: 'integer'
849
+ format: 'double'
850
+ example: 24
851
+ uom:
852
+ type: 'integer'
853
+ format: 'double'
854
+ example: 0
855
+ releaseQty:
856
+ type: 'integer'
857
+ example: 5
858
+ releaseUomValue:
859
+ type: 'integer'
860
+ example: 5
861
+ product:
862
+ type: 'object'
863
+ properties:
864
+ sku:
865
+ type: 'string'
866
+ example: ' '
867
+ brandSku:
868
+ type: 'string'
869
+ example: ' '
870
+ name:
871
+ type: 'string'
872
+ example: ' '
873
+ description:
874
+ type: 'string'
875
+ example: ' '
876
+ orderToteItems:
877
+ type: 'array'
878
+ items:
879
+ type: 'object'
880
+ properties:
881
+ orderToteName:
882
+ type: 'string'
883
+ example: ' '
884
+ qty:
885
+ type: 'integer'
886
+ example: 2
887
+ orderToteSeals:
888
+ type: 'object'
889
+ properties:
890
+ name:
891
+ type: 'string'
892
+ example: ' '
893
+ attachments:
894
+ type: 'string'
895
+ example: ' '
896
+ totalCount:
897
+ type: 'integer'
898
+ example: 35
899
+ limit:
900
+ type: 'integer'
901
+ example: 100
902
+ offset:
903
+ type: 'integer'
904
+ example: 0
905
+ xml:
906
+ name: 'GetDeliveryOrderList'
907
+
908
+
909
+ paths:
910
+ # add-release-order
911
+ api/v1/warehouse/add-release-order:
486
912
  post:
487
913
  tags:
488
- - 'outbound'
489
- description: 'Update release order details'
490
- operationId: 'updateReleaseOrderDetails'
914
+ - 'Outbound'
915
+ summary: 'Add release order(s).'
916
+ description: 'Add Release order'
917
+ operationId: 'addReleaseOrder'
491
918
  produces:
492
919
  - 'application/json'
493
920
  parameters:
494
- - in: 'path'
495
- name: 'warehouseId'
496
- required: true
497
- type: 'string'
498
921
  - in: 'body'
499
922
  name: 'body'
500
- required: true
501
- schema:
923
+ schema:
502
924
  type: 'object'
503
925
  properties:
504
- releaseGood:
926
+ data:
505
927
  type: 'object'
928
+ required:
929
+ - 'bizplaceId'
930
+ - 'releaseDate'
931
+ - 'refNo'
932
+ - 'type'
933
+ - 'packingOption'
934
+ - 'exportOption'
935
+ - 'ownTransport'
936
+ - 'courierOption'
937
+ - 'orderInventories'
506
938
  properties:
507
- id:
508
- type: 'uuid'
509
- example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626'
510
- collectionOrderNo:
939
+ bizplaceId:
511
940
  type: 'string'
512
- refNo:
941
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
942
+ required: true
943
+ releaseDate:
513
944
  type: 'string'
514
- refNo2:
945
+ example: '2022-07-01'
946
+ required: true
947
+ refNo:
515
948
  type: 'string'
516
- refNo3:
949
+ example: '2206308RFYKUCV'
950
+ required: true
951
+ refNo2:
517
952
  type: 'string'
518
- marketplaceOrderStatus:
953
+ example: '2206308RFYKUCV'
954
+ refNo3:
519
955
  type: 'string'
520
- billingAddress:
956
+ example: 'string'
957
+ type:
521
958
  type: 'string'
522
- deliveryAddress1:
959
+ enum: [b2c, b2b]
960
+ required: true
961
+ transporter:
523
962
  type: 'string'
524
- attentionTo:
963
+ example: 'Others (West Malaysia)'
964
+ trackingNo:
525
965
  type: 'string'
526
- city:
966
+ example: 'SBOP220701000290101'
967
+ packingOption:
968
+ type: 'boolean'
969
+ example: true
970
+ required: true
971
+ exportOption:
972
+ type: 'boolean'
973
+ example: false
974
+ required: true
975
+ ownTransport:
976
+ type: 'boolean'
977
+ example: true
978
+ required: true
979
+ courierOption:
980
+ type: 'boolean'
981
+ example: true
982
+ required: true
983
+ collectionOrderNo:
527
984
  type: 'string'
528
- country:
985
+ example: '2206308RFYKUCV'
986
+ description: '// compulsory when ownTransport is true'
987
+ shippingOrder:
988
+ type: 'object'
989
+ description: '// compulsory when exportOption is true'
990
+ type: 'object'
991
+ required:
992
+ - 'shipName'
993
+ - 'containerNo'
994
+ - 'containerArrivalDate'
995
+ - 'containerLeavingDate'
996
+ properties:
997
+ shipName:
998
+ type: 'string'
999
+ example: 'string'
1000
+ required: true
1001
+ containerNo:
1002
+ type: 'string'
1003
+ example: 'string'
1004
+ required: true
1005
+ loadType:
1006
+ type: 'string'
1007
+ example: 'string'
1008
+ from:
1009
+ type: 'string'
1010
+ example: 'string'
1011
+ to:
1012
+ type: 'string'
1013
+ example: 'string'
1014
+ containerArrivalDate:
1015
+ type: 'string'
1016
+ example: '2020-02-14'
1017
+ required: true
1018
+ containerLeavingDate:
1019
+ type: 'string'
1020
+ example: '2020-02-14'
1021
+ required: true
1022
+ deliverTo:
1023
+ type: 'object'
1024
+ properties:
1025
+ deliveryAddress1:
1026
+ type: 'string'
1027
+ example: 'No 14 Lorong 9A Tman Peruda Fasa 1B Kuala Muda 08000 Kedah'
1028
+ deliveryAddress2:
1029
+ type: 'string'
1030
+ example: 'string'
1031
+ deliveryAddress3:
1032
+ type: 'string'
1033
+ example: 'string'
1034
+ deliveryAddress4:
1035
+ type: 'string'
1036
+ example: 'string'
1037
+ deliveryAddress5:
1038
+ type: 'string'
1039
+ example: 'string'
1040
+ attentionTo:
1041
+ type: 'string'
1042
+ example: 'Rokiah bt Bakar'
1043
+ city:
1044
+ type: 'string'
1045
+ example: 'Kuala Muda'
1046
+ postalCode:
1047
+ type: 'string'
1048
+ example: '08000'
1049
+ country:
1050
+ type: 'string'
1051
+ example: 'Malaysia'
1052
+ state:
1053
+ type: 'string'
1054
+ example: 'Kedah'
1055
+ phone1:
1056
+ type: 'string'
1057
+ example: '60174396110'
1058
+ phone2:
1059
+ type: 'string'
1060
+ example: 'string'
1061
+ marketplaceOrderStatus:
529
1062
  type: 'string'
530
- postalCode:
1063
+ example: 'ready_to_ship'
1064
+ airwayBill:
531
1065
  type: 'string'
532
- phone1:
1066
+ example: 'string'
1067
+ invoice:
533
1068
  type: 'string'
534
- transporter:
1069
+ example: 'string'
1070
+ attentionCompany:
535
1071
  type: 'string'
536
- trackingNo:
1072
+ example: 'string'
1073
+ email:
537
1074
  type: 'string'
538
- airwayBill:
1075
+ example: 'string'
1076
+ packageId:
539
1077
  type: 'string'
540
- invoice:
1078
+ example: 'string'
1079
+ storeName:
541
1080
  type: 'string'
542
- shippingOrder:
543
- type: 'object'
544
- properties:
545
- shipName:
1081
+ example: 'string'
1082
+ storeId:
546
1083
  type: 'string'
547
- containerNo:
1084
+ example: 'string'
1085
+ routeId:
548
1086
  type: 'string'
549
- loadType:
1087
+ example: 'string'
1088
+ stopId:
550
1089
  type: 'string'
551
- from:
1090
+ example: 'string'
1091
+ source:
552
1092
  type: 'string'
553
- to:
1093
+ example: 'string'
1094
+ remark:
1095
+ type: 'string'
1096
+ example: 'string'
1097
+ requiredDraft:
1098
+ type: 'boolean'
1099
+ example: false
1100
+ orderInventories:
1101
+ type: 'array'
1102
+ items:
1103
+ type: 'object'
1104
+ required:
1105
+ - 'product'
1106
+ - 'releaseQty'
1107
+ properties:
1108
+ product:
1109
+ type: 'object'
1110
+ required:
1111
+ - 'sku'
1112
+ properties:
1113
+ sku:
1114
+ type: 'string'
1115
+ example: '1172790'
1116
+ required: true
1117
+ refCode:
1118
+ type: 'string'
1119
+ example: 'string'
1120
+ releaseQty:
1121
+ type: 'integer'
1122
+ example: 1
1123
+ required: true
1124
+ packingType:
1125
+ type: 'string'
1126
+ example: 'string'
1127
+ packingSize:
1128
+ type: 'integer'
1129
+ format: 'double'
1130
+ example: 1
1131
+ billTo:
1132
+ type: 'object'
1133
+ properties:
1134
+ billingAddress:
1135
+ type: 'string'
1136
+ example: 'string'
1137
+ responses:
1138
+ '200':
1139
+ description: 'success'
1140
+ content:
1141
+ application/json:
1142
+ schema:
1143
+ type: 'array'
1144
+ items:
1145
+ $ref: '#/definitions/AddReleaseOrder'
1146
+
1147
+ # cancel-release-order
1148
+ api/v1/warehouse/cancel-release-order:
1149
+ post:
1150
+ tags:
1151
+ - 'Outbound'
1152
+ summary: 'Cancel release order(s).'
1153
+ description: 'Cancel Release Order'
1154
+ operationId: 'cancelReleaseOrder'
1155
+ produces:
1156
+ - 'application/json'
1157
+ parameters:
1158
+ - in: 'body'
1159
+ name: 'body'
1160
+ schema:
1161
+ type: 'object'
1162
+ properties:
1163
+ data:
1164
+ type: 'object'
1165
+ properties:
1166
+ bizplaceId:
554
1167
  type: 'string'
555
- containerArrivalDate:
1168
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
1169
+ required: true
1170
+ roNo:
556
1171
  type: 'string'
557
- example: '2020-02-14'
558
- containerLeavingDate:
1172
+ example: 'xxxxx'
1173
+ required: true
1174
+ remark:
559
1175
  type: 'string'
560
- example: '2020-02-14'
1176
+ example: 'reference reference'
1177
+ required: true
1178
+
561
1179
  responses:
562
1180
  '200':
563
- description: 'Successful Operation'
564
- '400':
565
- description: 'Bad request is sent'
566
- '401':
567
- description: 'Authentication Error'
568
- '404':
569
- description: 'Resource not found'
570
- '500':
571
- description: 'Server error'
572
- deprecated: false
573
- /warehouse/{warehouseId}/get-release-order-list:
1181
+ description: 'success'
1182
+ content:
1183
+ application/json:
1184
+ schema:
1185
+ type: 'array'
1186
+ items:
1187
+ $ref: '#/definitions/CancelReleaseOrder'
1188
+
1189
+ # update-release-order-details
1190
+ api/v1/warehouse/update-release-order-details:
1191
+ post:
1192
+ tags:
1193
+ - 'Outbound'
1194
+ summary: 'Update release order details.'
1195
+ description: 'Update Release Order Details'
1196
+ operationId: 'updateReleaseOrderDetails'
1197
+ produces:
1198
+ - 'application/json'
1199
+ parameters:
1200
+ - in: 'body'
1201
+ name: 'body'
1202
+ schema:
1203
+ type: 'object'
1204
+ properties:
1205
+ data:
1206
+ type: 'object'
1207
+ required:
1208
+ - 'releaseGood'
1209
+ properties:
1210
+ bizplaceId:
1211
+ type: 'string'
1212
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
1213
+ required: true
1214
+ releaseGood:
1215
+ type: 'object'
1216
+ required:
1217
+ - 'bizplaceId'
1218
+ - 'roId'
1219
+ properties:
1220
+ roId:
1221
+ type: 'string'
1222
+ example: '1d61cd39-f9de-4a28-8d24-981e6ea5c626 '
1223
+ required: true
1224
+ collectionOrderNo:
1225
+ type: 'string'
1226
+ example: 'string'
1227
+ refNo:
1228
+ type: 'string'
1229
+ example: 'string'
1230
+ refNo2:
1231
+ type: 'string'
1232
+ example: 'string'
1233
+ refNo3:
1234
+ type: 'string'
1235
+ example: 'string'
1236
+ marketplaceOrderStatus:
1237
+ type: 'string'
1238
+ example: 'string'
1239
+ billingAddress:
1240
+ type: 'string'
1241
+ example: 'string'
1242
+ deliveryAddress1:
1243
+ type: 'string'
1244
+ example: 'string'
1245
+ attentionTo:
1246
+ type: 'string'
1247
+ example: 'string'
1248
+ city:
1249
+ type: 'string'
1250
+ example: 'string'
1251
+ country:
1252
+ type: 'string'
1253
+ example: 'string'
1254
+ postalCode:
1255
+ type: 'string'
1256
+ example: 'string'
1257
+ phone1:
1258
+ type: 'string'
1259
+ example: 'string'
1260
+ transporter:
1261
+ type: 'string'
1262
+ example: 'string'
1263
+ trackingNo:
1264
+ type: 'string'
1265
+ example: 'string'
1266
+ airwayBill:
1267
+ type: 'string'
1268
+ example: 'string'
1269
+ invoice:
1270
+ type: 'string'
1271
+ example: 'string'
1272
+ shippingOrder:
1273
+ type: 'object'
1274
+ required:
1275
+ - 'shipName'
1276
+ - 'containerNo'
1277
+ - 'containerArrivalDate'
1278
+ - 'containerLeavingDate'
1279
+ properties:
1280
+ shipName:
1281
+ type: 'string'
1282
+ example: 'string'
1283
+ required: true
1284
+ containerNo:
1285
+ type: 'string'
1286
+ example: 'string'
1287
+ required: true
1288
+ loadType:
1289
+ type: 'string'
1290
+ example: 'string'
1291
+ from:
1292
+ type: 'string'
1293
+ example: 'string'
1294
+ to:
1295
+ type: 'string'
1296
+ example: 'string'
1297
+ containerArrivalDate:
1298
+ type: 'string'
1299
+ example: '2020-02-14'
1300
+ required: true
1301
+ containerLeavingDate:
1302
+ type: 'string'
1303
+ example: '2020-02-14'
1304
+ required: true
1305
+ responses:
1306
+ '200':
1307
+ description: 'success'
1308
+ content:
1309
+ application/json:
1310
+ schema:
1311
+ type: 'array'
1312
+ items:
1313
+ $ref: '#/definitions/UpdateReleaseOrderDetails'
1314
+
1315
+ # get-release-order-list
1316
+ api/v1/warehouse/get-release-order-list:
574
1317
  get:
575
1318
  tags:
576
- - 'outbound'
577
- description: 'Use this API to get release orders from WMS.'
1319
+ - 'Outbound'
1320
+ summary: 'Get list of release order.'
1321
+ description: 'Get list of Release Order.'
578
1322
  operationId: 'getReleaseOrderList'
1323
+ consumes:
1324
+ - 'application/json'
579
1325
  produces:
580
1326
  - 'application/json'
581
1327
  parameters:
582
- - in: 'path'
583
- name: 'warehouseId'
1328
+ - in: 'query'
1329
+ name: 'bizplaceId'
1330
+ type: 'string'
584
1331
  required: true
1332
+ - in: 'query'
1333
+ name: 'roNo'
1334
+ type: 'string'
1335
+ - in: 'query'
1336
+ name: 'status'
585
1337
  type: 'string'
586
1338
  - in: 'query'
587
1339
  name: 'fromDate'
588
- required: false
589
1340
  type: 'string'
1341
+ description: '(Must use in conjunction with “toDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
1342
+ default: '7 days before current datetime.'
590
1343
  - in: 'query'
591
1344
  name: 'toDate'
592
- required: false
593
1345
  type: 'string'
1346
+ description: '(Must use in conjunction with “fromDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
1347
+ default: 'Current datetime.'
594
1348
  - in: 'query'
595
- name: 'paginationEntriesPerPage'
596
- 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.'
1349
+ name: 'limit'
597
1350
  type: 'integer'
598
- format: 'uint32'
1351
+ default: 100
1352
+ max: 100
599
1353
  - in: 'query'
600
- name: 'paginationOffset'
601
- 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.'
1354
+ name: 'offset'
602
1355
  type: 'integer'
603
- format: 'uint32'
1356
+ default: 0
604
1357
  responses:
605
1358
  '200':
606
1359
  description: 'successful operation'
@@ -609,95 +1362,84 @@ paths:
609
1362
  schema:
610
1363
  type: 'array'
611
1364
  items:
612
- $ref: '#/definitions/Outbound'
613
- '400':
614
- description: 'Bad request is sent'
615
- '401':
616
- description: 'Authentication Error'
617
- '404':
618
- description: 'Resource not found'
619
- '500':
620
- description: 'Server error'
621
- deprecated: false
622
- /warehouse/{warehouseId}/get-release-order-detail:
1365
+ $ref: '#/definitions/GetReleaseOrderList'
1366
+
1367
+ # get-release-order-details
1368
+ api/v1/warehouse/get-release-order-details:
623
1369
  get:
624
1370
  tags:
625
- - 'outbound'
626
- description: 'Use this API to get single outbound order detail from WMS.'
627
- operationId: 'getOutboundOrderDetail'
1371
+ - 'Outbound'
1372
+ summary: 'Get release order details.'
1373
+ description: 'Get Release Order Details.'
1374
+ operationId: 'getReleaseOrderDetails'
1375
+ consumes:
1376
+ - 'application/json'
628
1377
  produces:
629
1378
  - 'application/json'
630
1379
  parameters:
631
- - in: 'path'
632
- name: 'warehouseId'
633
- required: true
1380
+ - in: 'query'
1381
+ name: 'bizplaceId'
634
1382
  type: 'string'
635
- - name: 'releaseOrderNo'
636
- in: 'query'
637
- description: 'The specific release order no.'
638
1383
  required: true
1384
+ - in: 'query'
1385
+ name: 'roNo'
639
1386
  type: 'string'
1387
+ required: true
640
1388
  responses:
641
1389
  '200':
642
1390
  description: 'successful operation'
643
1391
  content:
644
1392
  application/json:
645
1393
  schema:
646
- $ref: '#/definitions/Outbound'
647
- '400':
648
- description: 'Bad request is sent'
649
- '401':
650
- description: 'Authentication Error'
651
- '404':
652
- description: 'Resource not found'
653
- '500':
654
- description: 'Server error'
655
- deprecated: false
656
- /warehouse/{warehouseId}/get-delivery-orders:
1394
+ type: 'array'
1395
+ items:
1396
+ $ref: '#/definitions/GetReleaseOrderDetails'
1397
+
1398
+ # get-delivery-order-list
1399
+ api/v1/warehouse/get-delivery-order-list:
657
1400
  get:
658
1401
  tags:
659
- - 'outbound'
660
- description: 'Use this API to get a list of delivery orders from WMS.'
661
- operationId: 'getDeliveryOrder'
1402
+ - 'Outbound'
1403
+ summary: 'Get delivery order list.'
1404
+ description: 'Get Delivery Order List.'
1405
+ operationId: 'getDeliveryOrderList'
1406
+ consumes:
1407
+ - 'application/json'
662
1408
  produces:
663
1409
  - 'application/json'
664
1410
  parameters:
665
- - in: 'path'
666
- name: 'warehouseId'
667
- required: true
1411
+ - in: 'query'
1412
+ name: 'bizplaceId'
668
1413
  type: 'string'
669
- - name: 'fromDate'
670
- in: 'query'
671
1414
  required: true
1415
+ - in: 'query'
1416
+ name: 'doNo'
672
1417
  type: 'string'
673
- - name: 'toDate'
674
- in: 'query'
675
- description: 'Maximum date range is 1 month'
676
- required: true
1418
+ - in: 'query'
1419
+ name: 'fromDate'
1420
+ type: 'string'
1421
+ description: '(Must use in conjunction with “toDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
1422
+ default: '7 days before current datetime.'
1423
+ - in: 'query'
1424
+ name: 'toDate'
677
1425
  type: 'string'
678
- - name: 'limit'
679
- in: 'query'
680
- default: 10
681
- required: false
682
- type: 'number'
683
- - name: 'page'
684
- in: 'query'
685
- default: 1
686
- required: false
687
- type: 'number'
1426
+ description: '(Must use in conjunction with “fromDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
1427
+ default: 'Current datetime.'
1428
+ - in: 'query'
1429
+ name: 'limit'
1430
+ type: 'integer'
1431
+ default: 100
1432
+ max: 100
1433
+ - in: 'query'
1434
+ name: 'offset'
1435
+ type: 'integer'
1436
+ default: 0
688
1437
  responses:
689
1438
  '200':
690
1439
  description: 'successful operation'
691
1440
  content:
692
1441
  application/json:
693
1442
  schema:
694
- $ref: '#/definitions/DO'
695
- '400':
696
- description: 'Bad request is sent'
697
- '401':
698
- description: 'Authentication Error'
699
- '404':
700
- description: 'Resource not found'
701
- '500':
702
- description: 'Server error'
703
- deprecated: false
1443
+ type: 'array'
1444
+ items:
1445
+ $ref: '#/definitions/GetDeliveryOrderList'