-
Notifications
You must be signed in to change notification settings - Fork 0
/
api-specification.yaml
1405 lines (1405 loc) · 42 KB
/
api-specification.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Logistics Order
description: API to create and retrieve logistics orders
contact:
name: API Support
url: https://developer.my.gw-world.com/support
version: 1.0.0
x-category: logistics
x-apiId: logisticsOrderCustomer
x-audience: external partner
servers:
- url: https://my.api.gw-world.com/logistics/logistics-order/1.0.0
paths:
/logistics-order:
post:
summary: create a logisticsOrder
description: posts an logisticsOrder structure to GW to create a new logisticsOrder
parameters:
- name: accept-language
in: header
description: set the response language, default is en-US - defines the language following the BCP 47 standard https://tools.ietf.org/html/bcp47
required: false
style: simple
explode: false
schema:
$ref: '#/components/schemas/Language'
requestBody:
description: request body containing logisticsOrder and callback-url
content:
application/json:
schema:
type: object
properties:
logisticsOrder:
$ref: '#/components/schemas/LogisticsOrder'
callbacks:
type: object
properties:
successCallback:
$ref: '#/components/schemas/CallbackUrl'
fulfillmentCallback:
$ref: '#/components/schemas/CallbackUrl'
description: set of callback URL for asynchronous event responses with different purpose
responses:
'202':
description: Logistics order accepted, confirmation will be sent later
content:
application/json:
schema:
type: object
additionalProperties: false
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
callbacks:
onSuccess:
'{$request.body.callbacks.successCallback}':
post:
requestBody:
description: payload for the success event, logisticsOrder has been created
content:
application/json:
schema:
required:
- customerOrder
- orderId
- status
- timestamp
type: object
properties:
orderId:
$ref: '#/components/schemas/GWOrderId'
customerOrder:
$ref: '#/components/schemas/Reference/properties/reference'
timestamp:
$ref: '#/components/schemas/DateTime'
transportProduct:
$ref: '#/components/schemas/TransportProduct/properties/product'
trackingUrl:
type: string
description: tracking link for this fulfilment, if transport is booked (no self-pickup)
format: url
status:
$ref: '#/components/schemas/EventCallback'
required: true
responses:
'200':
description: Your server returns this code if it accepts the callback
onFulfillment:
'{$request.body.callbacks.fulfillmentCallback}':
post:
requestBody:
description: payload for the success event, logisticsOrder has been created
content:
application/json:
schema:
required:
- customerOrder
- orderId
- status
- timestamp
- transportProduct
type: object
properties:
orderId:
$ref: '#/components/schemas/GWOrderId'
customerOrder:
$ref: '#/components/schemas/Reference/properties/reference'
timestamp:
$ref: '#/components/schemas/DateTime'
transportProduct:
$ref: '#/components/schemas/TransportProduct/properties/product'
trackingUrl:
type: string
description: tracking link for this fulfilment, if transport is booked (no self-pickup)
format: url
status:
$ref: '#/components/schemas/EventCallback'
required: true
responses:
'200':
description: Your server returns this code if it accepts the callback
security:
- default:
- API_CUSAPI_LOGISTICS_ORDER_CREATE
x-throttling-tier: 1KPerMin
/logistics-order/{orderId}/current-status:
get:
summary: by identifying your logistics-order using the orderId in the path, you get the current status of the logistics-order
operationId: getStatusByOrderId
parameters:
- name: orderId
in: path
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/GWOrderId'
- name: calculateETA
in: query
description: includes the calculation of an ETA if it is a logistics order
required: false
style: form
explode: true
schema:
type: boolean
default: false
- name: accept-language
in: header
description: set the response language, default is en-US - defines the language following the BCP 47 standard https://tools.ietf.org/html/bcp47
required: false
style: simple
explode: false
schema:
$ref: '#/components/schemas/Language'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/OrderCurrentStatus'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
'404':
description: Not Found
security:
- default:
- API_CUSAPI_LOGISTICS_ORDER_READ
x-scope: API_LOGISTICS_ORDER_READ
x-auth-type: Application & Application User
x-throttling-tier: 1KPerMin
/logistics-order/{orderId}/:
get:
summary: by identifying your logistics-order using the orderId in the path, you get the data of the logistics-order
operationId: getLogisticsOrderByOrderId
parameters:
- name: orderId
in: path
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/GWOrderId'
- name: accept-language
in: header
description: set the response language, default is en-US - defines the language following the BCP 47 standard https://tools.ietf.org/html/bcp47
required: false
style: simple
explode: false
schema:
$ref: '#/components/schemas/Language'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogisticsOrder'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
'404':
description: Not Found
security:
- default:
- API_CUSAPI_LOGISTICS_ORDER_READ
x-scope: API_LOGISTICS_ORDER_READ
x-auth-type: Application & Application User
x-throttling-tier: 1KPerMin
components:
schemas:
Country:
type: string
description: defines the country following IS-3166-1 Alpha2, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
format: iso-3166
example: AT
DateTime:
maxLength: 29
type: string
description: date / time in format yyyy-mm-ddThh:mm:ss.mmm±hh:mm following the RFC 3339 standard, see https://tools.ietf.org/html/rfc3339
format: date-time
GWCustomerId:
maximum: 9999999
minimum: 100000
type: integer
description: customer account number of GW
format: int32
example: 123456
CustomerOrder:
type: string
description: reference from the customer
example: customer_order
Incoterm:
type: object
properties:
code:
type: string
description: code according to Incoterms 2020
example: DPU
enum:
- EXW
- FCA
- CPT
- CIP
- DAP
- DPU
- DDP
- FAS
- FOB
- CFR
- CIF
location:
type: string
description: place for the incoterm
example: Wien
description: Incoterm code and location
MyGWStatusCode:
type: string
description: status as in myGW shown
example: OPEN
enum:
- OPEN
- IN_PROGRESS
- ATTENTION
- CRITICAL
- COMPLETED
GeoLocation:
type: object
properties:
latitude:
type: number
description: latitude of the event location if available
example: 47.4671709
longitude:
type: number
description: longitude of the event location if available
example: 9.6720238
description: geographical location in longitude and latitude
Location:
type: object
properties:
locationInformation:
type: string
description: location information
example: Lauterach
countryCode:
$ref: '#/components/schemas/Country'
geoLocation:
$ref: '#/components/schemas/GeoLocation'
description: location e.g. of a status event
Address:
type: object
properties:
name1:
maxLength: 35
type: string
description: name 1 of the address
example: name 1
name2:
maxLength: 35
type: string
description: name 2 of the address
example: name 2
name3:
maxLength: 35
type: string
description: name 3 of the address
example: name 3
name4:
maxLength: 35
type: string
description: name 4 of the address
example: name 4
street1:
maxLength: 35
type: string
description: street 1 of the address
example: street 1
street2:
maxLength: 35
type: string
description: street 2 of the address
example: street 2
street3:
maxLength: 35
type: string
description: street 3 of the address
example: street 3
postbox:
maxLength: 9
type: string
description: postbox of the address
example: postbox
city:
maxLength: 35
type: string
description: city of the address
example: Lauterach
zipCode:
maxLength: 10
type: string
description: zipcode of the address
example: '6923'
countryCode:
$ref: '#/components/schemas/Country'
state:
type: string
description: state or province or territory of the address
example: Vorarlberg
location:
description: location information
allOf:
- $ref: '#/components/schemas/Location'
description: address
Date:
type: string
description: date in format yyyy-mm-dd
format: date
Translation:
type: object
properties:
languageRequested:
$ref: '#/components/schemas/Language'
translationResolved:
$ref: '#/components/schemas/LingualText'
translationOriginal:
$ref: '#/components/schemas/LingualText'
description: the translation object returns a translated text. It shows the requested language, as well as the original text. If feasible the original text is translated to the requested language. If not feasible, the resolved text contains the English translation
EtaInfo:
type: object
properties:
estimatedTimeOfArrivalMin:
$ref: '#/components/schemas/DateTime'
estimatedTimeOfArrivalMax:
$ref: '#/components/schemas/DateTime'
etaSpecification:
type: string
description: how is the ETA calculated, what does it express
example: ETA at recipient
enum:
- ATA at recipient
- ETA at recipient
- ATA at destination (air)port
- ETA at destination (air)port
description: describes a time window for the estimated time of arrival
LingualText:
type: object
properties:
text:
type: string
description: text
example: lorem ipsum
language:
$ref: '#/components/schemas/Language'
description: this object contains a text plus the language identifier, showing the language of the given text
GWOrderId:
maxLength: 10
minLength: 10
pattern: '[0-9A-Z]{10}'
type: string
description: the GW orderId is always a 10 digit number
example: ABC4567890
GWWarehouseId:
maxLength: 12
minLength: 10
type: string
example: 123456_ABC
OrderReferenced:
required:
- creationDate
- customerId
- orderId
type: object
properties:
customerId:
$ref: '#/components/schemas/GWCustomerId'
orderId:
$ref: '#/components/schemas/GWOrderId'
creationDate:
$ref: '#/components/schemas/Date'
references:
uniqueItems: true
type: array
description: references of the order
items:
$ref: '#/components/schemas/Reference'
description: shortest form of an order information, used to identify the referenced order in responses
Reference:
type: object
properties:
qualifier:
type: string
description: qualifier for the reference
example: GENERAL
enum:
- GENERAL
- DELIVERY_NOTE
- EXTERNAL_ORDERTYPE
reference:
maxLength: 35
type: string
description: reference string
example: '12345'
description: general reference
CustomizedInformation:
type: object
properties:
qualifier:
type: string
description: qualifier for the customized information
example: CUSTOMIZED_INFORMATION1
enum:
- CUSTOMIZED_INFORMATION1
- CUSTOMIZED_INFORMATION2
- CUSTOMIZED_INFORMATION3
- CUSTOMIZED_INFORMATION4
- CUSTOMIZED_INFORMATION5
- CUSTOMIZED_INFORMATION6
- CUSTOMIZED_INFORMATION7
- CUSTOMIZED_INFORMATION8
- CUSTOMIZED_INFORMATION9
- CUSTOMIZED_INFORMATION10
- CUSTOMIZED_INFORMATION11
- CUSTOMIZED_INFORMATION12
- CUSTOMIZED_INFORMATION13
- CUSTOMIZED_INFORMATION14
- CUSTOMIZED_INFORMATION15
- CUSTOMIZED_INFORMATION16
- CUSTOMIZED_INFORMATION17
- CUSTOMIZED_INFORMATION18
- CUSTOMIZED_INFORMATION19
- CUSTOMIZED_INFORMATION20
reference:
type: string
description: reference string
example: customized information
description: customized information
ErrorMessage:
type: object
properties:
text:
$ref: '#/components/schemas/Translation'
logInfo:
type: object
properties:
code:
type: string
description: GW coded message
example: '4711'
x-apiId:
type: string
description: id to identify the API
example: statusCustomerPartner
x-correlation-Id:
type: string
description: GW log entry id
example: 1234567-0
description: structured information for GW support
additionalProperties: false
description: standard structure for response messages
Language:
maxLength: 5
pattern: '[a-z][a-z]\-[A-Z][A-Z]'
type: string
description: defines the language following the BCP 47 standard https://tools.ietf.org/html/bcp47
format: bcp47
example: de-DE
AddressReference:
type: object
properties:
qualifier:
type: string
description: qualifier for the address reference
example: GENERAL
enum:
- CUSTOMER_ID
- GENERAL
reference:
maxLength: 35
type: string
description: reference ID for the address with the given qualification
example: '12345'
description: adds additional references to an address
Contact:
type: object
properties:
function:
type: string
description: function of the contact
example: Purchasing Manager
fax:
type: string
description: fax number of the contact
example: +43/1/234-9
surname:
type: string
description: surname of the contact
example: Max
name:
type: string
description: name of the contact
example: Mustermann
language:
$ref: '#/components/schemas/Language'
title:
type: string
description: title of the contact
example: Dr.
mobile:
type: string
description: mobile phone number of the contact
example: +43/1/234
phone:
type: string
description: phone number of the contact
example: +43/1/234
salutation:
type: string
description: salutation of the contact
example: Mister
enum:
- Mister
- Misses
- Miss
- ''
email:
type: string
description: email of the contact
format: email
example: max@mustermann.info
description: contact information
GWEventCode:
type: string
description: gives a coded status for the order
example: RDGW300
enum:
- RDGW100
- RDGW165
- RDGW610
- RDGW166
- RDGW180
- RDGW290
- RDGW300
- RDGW400
- RDGW450
- RDGW810
- RDGW820
- RDGW830
- RDGW850
- RDGW860
- AGW100
- ASGWP05
- AGWM09
- ASGWP10
- ASGWP20
- ASGWP25
- AGWM71
- AGWI24
- AGWM24
- AGWM43
- AGWM11
- ASGWP40
- AGWM31
- AGWI10
- AGWM10
- AGWM44
- AGWM73
- ASGWP50
- ASGWP53
- ASGWP55
- AGWM21
- AGWM75
- ASGWP60
- AGWM77
- AGWM13
- AGWI21
- AGWM14
- SGW100
- SGWOEE
- SGWM09
- ASGWP30
- SGWM33
- SGWM72
- SGWOAE
- SGWOVD
- SGWM24
- SGWM10
- SGWM73
- SGWO0A
- SGWOVA
- SGWM79
- SGWOUV
- SGWORD
- SGWM21
- SGWM75
- SGWO0D
- SGWM12
- SGWM77
- SGWM13
- SGWM14
- LGWIN
- LGWIA
- LGWIF
- LGWON
- LGWOA
- LGWOF
- '*LS2*090'
- '*LS2*105'
- '*LS2*110'
- '*LS2*120'
Measurement:
type: object
properties:
measureQualifier:
type: string
description: type of the measure
example: GROSS_WEIGHT
enum:
- NET_WEIGHT
- GROSS_WEIGHT
- TARE_WEIGHT
- CHARGEABLE_WEIGHT
- NET_VOLUME
- GROSS_VOLUME
- MINIMUM_TEMPERATURE
- MAXIMUM_TEMPERATURE
- CONTROL_TEMPERATURE
- LOADING_UNITS
- FLOOR_SPACE
- TOTAL_DISTANCE
- TOLL_DISTANCE
measureUnit:
type: string
description: unit of the measure
example: KGM
enum:
- FAH
- FOT
- FTK
- FTQ
- GLI
- GRM
- INH
- KEL
- KGM
- KTM
- LTR
- MMT
- MTK
- MTQ
- MTR
- SMI
measure:
type: number
description: value of the measure, e.g. the weight. Respect the number of decimals allowed. For weights 0 decimals. For distances 1 decimal. For floor spaces 2 decimals. For volumes 3 decimals. For temperature 1 decimal.
format: float
example: 123
description: measure object to represent a measure like a weight
GWEventReasonCode:
type: string
description: gives and additional reason code, not mandatory
example: additional reason code
enum:
- '1'
- '2'
- '4'
- '5'
- '8'
- '9'
- '10'
- '11'
- '12'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '20'
- '22'
- '54'
- '56'
- '63'
- '64'
- '66'
- '67'
- '68'
- '69'
- '70'
- '72'
- '74'
- '80'
- '81'
- '82'
- '83'
- '84'
- '85'
- '89'
- '90'
- '95'
- '99'
- '100'
- '124'
- '138'
- '172'
- '711'
- '1111'
- '3321'
- '3333'
- A12
- BC1
- BC2
- CA2
- CP1
- CP2
- CR1
- CR11
- CR2
- DG6
- E01
- E02
- E11
- E21
- E22
- E23
- E24
- E25
- E27
- E29
- E31
- E32
- E33
- E34
- E35
- E37
- E38
- E39
- E40
- E4A5
- E4AM
- E4AO
- E4BS
- E51
- E62
- FM4
- FM7
- FM8
- MH1
- MH6
- MOB
- PC1
- RA1
GoodsItem:
required:
- description
- measurements
- packageType
- position
- quantity
type: object
properties:
position:
type: string
description: position of goods
example: P1
quantity:
maximum: 999999.999
minimum: 0.001
type: number
description: defines the quantity of shipping units
format: float
example: 3.25
packageType:
$ref: '#/components/schemas/PackageType'
description:
maxLength: 200
type: string
description: description of goods
example: goods example
stackable:
type: boolean
description: indicates the stackabiltiy of the goods
example: false
default: false
measurements:
uniqueItems: true
type: array
description: goods measurements
items:
$ref: '#/components/schemas/Measurement'
dimensions:
$ref: '#/components/schemas/Dimension'
references:
uniqueItems: true
type: array
description: goods references
items:
$ref: '#/components/schemas/GoodsItemReference'
description: goods information
PackageType:
type: string
description: the package type is following the UN/ECE recommendation 21, using 2 character codes. See https://www.unece.org/fileadmin/DAM/cefact/recommendations/rec21/rec21rev4_ecetrd309.pdf
example: UC
enum:
- UC
- CV
- PE
- PX
- BE
- PB
- PK
Dimension:
type: object
properties:
length:
type: number
description: goods length
format: float
example: 1.2
width:
type: number
description: goods width
format: float
example: 0.8
height:
type: number
description: goods height
format: float
example: 1.8
dimensionUnit:
type: string
description: unit for the dimension
example: MTR
enum:
- MTR
- MMT
- FOT
- INH
description: goods dimension
Event:
type: object
properties:
eventCode:
$ref: '#/components/schemas/GWEventCode'
eventDateTime:
$ref: '#/components/schemas/DateTime'
eventSignee:
type: string
description: Person (or system) which reported the event or signed it
example: Michael Beck
eventDescription:
$ref: '#/components/schemas/Translation'
myGwStatusCode:
$ref: '#/components/schemas/MyGWStatusCode'
location:
$ref: '#/components/schemas/Location'
eventReasonCode:
$ref: '#/components/schemas/GWEventReasonCode'
eventReason:
$ref: '#/components/schemas/Translation'
eventMetaCode:
$ref: '#/components/schemas/GWEventMetaCode'
description: status object, collecting all information of a status event
GWEventMetaCode:
type: string
description: gives a meta status for the order
example: UNLOADED
enum:
- RECEIVED
- DELIVERY_PREVENTED
- NOT_IN_DELIVERY
- UNSUCCESSFUL_PREADVICE
- ETA
- UNLOADED
- IN_TRANSIT
- IN_DELIVERY
- PICKED_UP
- NO_PICKUP
- DELIVERED
- DAMAGED
- SHORTAGE
- NOT_DELIVERED
- ACCEPTANCE_REFUSED
- RETURN
- INBOUND_STORAGE
- MISSING
- LOADED
- EXPORT_CUSTOMS
- HANDOVER_FROM_AGENT
- HANDOVER_TO_AGENT
- IMPORT_CUSTOMS
- READY4PICKUP
- ARRIVED_PORT
- DELAYED
- DEPARTED_PORT
- SHIPPED
- CONTAINER_DISPATCHED
- CONTAINER_RETURN
- REBOOKED
- COMPLETED
- IN_PLANNING
- OUTBOUND_STORAGE
EventCallback:
type: object
properties:
eventMetaCode:
$ref: '#/components/schemas/GWEventMetaCode'
description: status object, collecting status and translation information
OrderCurrentStatus:
type: object
properties:
etaInfo:
$ref: '#/components/schemas/EtaInfo'
statusCurrent:
$ref: '#/components/schemas/Event'
orderReferenced:
$ref: '#/components/schemas/OrderReferenced'
additionalProperties: false
description: contains a referenced order with the actual status and (if feasible) the estimated time of arrival
CallbackUrl:
type: string
description: defines the URL for an asynchronous callback. Must include https (only secured transfer allowed)
format: url
example: https://ms-server.com/mycallbackurl