@shipengine/connect-carrier-api 2.4.1 → 2.4.4
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.
- package/lib/models/relay-points/opening-times.d.ts +1 -0
- package/lib/models/relay-points/opening-times.js +1 -0
- package/lib/models/relay-points/opening-times.js.map +1 -1
- package/lib/models/relay-points/relay-point-address.d.ts +1 -1
- package/lib/models/relay-points/relay-point-address.js +1 -1
- package/lib/models/relay-points/relay-point-address.js.map +1 -1
- package/lib/models/relay-points/relay-point.d.ts +2 -2
- package/lib/models/relay-points/relay-point.js +3 -3
- package/lib/models/relay-points/relay-point.js.map +1 -1
- package/lib/requests/get-relay-points-request.d.ts +2 -0
- package/lib/requests/get-relay-points-request.js +1 -0
- package/lib/requests/get-relay-points-request.js.map +1 -1
- package/package.json +1 -1
- package/spec.json +575 -392
- package/src/models/relay-points/opening-times.ts +1 -0
- package/src/models/relay-points/relay-point-address.ts +2 -2
- package/src/models/relay-points/relay-point.ts +5 -5
- package/src/requests/get-relay-points-request.ts +2 -0
- package/tsconfig.tsbuildinfo +1 -1
package/spec.json
CHANGED
|
@@ -3,19 +3,21 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "ShipEngine Connect Carrier API",
|
|
5
5
|
"description": "This API specification describes the canonical ShipEngine Carrier API connector module. A module which implements one or more endpoints from this specification can be integrated with the ShipEngine Carrier Platform.",
|
|
6
|
-
"version": "1.
|
|
6
|
+
"version": "1.15.1"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
10
10
|
"post": {
|
|
11
|
-
"tags": [
|
|
12
|
-
|
|
11
|
+
"tags": [
|
|
12
|
+
"Account Setup"
|
|
13
|
+
],
|
|
14
|
+
"description": "This method is used to authenticate with your application. It is responsible for verifying the supplied\r\nuser credentials and establishing or renewing a connection. The authentication information will be\r\nstored in the metadata object and will be included in all request bodies. All applications must\r\nimplement the Register method.",
|
|
13
15
|
"operationId": "Register",
|
|
14
16
|
"parameters": [
|
|
15
17
|
{
|
|
16
18
|
"name": "ShipStation-TransactionID",
|
|
17
19
|
"in": "header",
|
|
18
|
-
"description": "Uniquely identifies the current transaction. If the transaction is retried
|
|
20
|
+
"description": "Uniquely identifies the current transaction. If the transaction is retried,\r\n then this transaction_id will remain the same. You can use this to detect and prevent duplicate\r\n operations.",
|
|
19
21
|
"schema": {
|
|
20
22
|
"type": "string",
|
|
21
23
|
"format": "uuid"
|
|
@@ -23,25 +25,13 @@
|
|
|
23
25
|
}
|
|
24
26
|
],
|
|
25
27
|
"requestBody": {
|
|
26
|
-
"description": "An object containing the authentication information gathered using the
|
|
28
|
+
"description": "An object containing the authentication information gathered using the\r\n connection form you created for your application. It will contain whatever fields you defined in this form.\r\n Your method must then use this data to perform authentication with your backend service.",
|
|
27
29
|
"content": {
|
|
28
30
|
"application/json": {
|
|
29
31
|
"schema": {
|
|
30
32
|
"$ref": "#/components/schemas/ExampleRegisterRequest"
|
|
31
33
|
},
|
|
32
|
-
"example": {
|
|
33
|
-
"registration_info": {
|
|
34
|
-
"username": "auctane-next-day",
|
|
35
|
-
"password": "password!",
|
|
36
|
-
"meter_number": "8675309"
|
|
37
|
-
},
|
|
38
|
-
"transaction_id": "00000000-0000-0000-0000-000000000000",
|
|
39
|
-
"metadata": {
|
|
40
|
-
"username": "auctane-next-day",
|
|
41
|
-
"password": "password!",
|
|
42
|
-
"meter_number": "8675309"
|
|
43
|
-
}
|
|
44
|
-
}
|
|
34
|
+
"example": {"registration_info":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
|
|
45
35
|
}
|
|
46
36
|
}
|
|
47
37
|
},
|
|
@@ -96,17 +86,7 @@
|
|
|
96
86
|
"schema": {
|
|
97
87
|
"$ref": "#/components/schemas/RegisterResponse"
|
|
98
88
|
},
|
|
99
|
-
"example": {
|
|
100
|
-
"credentials": {
|
|
101
|
-
"username": "auctane-next-day",
|
|
102
|
-
"password": "password!"
|
|
103
|
-
},
|
|
104
|
-
"metadata": {
|
|
105
|
-
"username": "auctane-next-day",
|
|
106
|
-
"password": "password!",
|
|
107
|
-
"meter_number": "8675309"
|
|
108
|
-
}
|
|
109
|
-
}
|
|
89
|
+
"example": {"credentials":{"username":"auctane-next-day","password":"password!"},"metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
|
|
110
90
|
}
|
|
111
91
|
}
|
|
112
92
|
}
|
|
@@ -115,7 +95,9 @@
|
|
|
115
95
|
},
|
|
116
96
|
"/CreateLabel": {
|
|
117
97
|
"post": {
|
|
118
|
-
"tags": [
|
|
98
|
+
"tags": [
|
|
99
|
+
"Labels"
|
|
100
|
+
],
|
|
119
101
|
"description": "This method creates a new label.",
|
|
120
102
|
"operationId": "Create a Label",
|
|
121
103
|
"parameters": [
|
|
@@ -198,7 +180,9 @@
|
|
|
198
180
|
},
|
|
199
181
|
"/VoidLabels": {
|
|
200
182
|
"post": {
|
|
201
|
-
"tags": [
|
|
183
|
+
"tags": [
|
|
184
|
+
"Labels"
|
|
185
|
+
],
|
|
202
186
|
"description": "This method is used to void a previously created labels.",
|
|
203
187
|
"operationId": "Void a Label",
|
|
204
188
|
"parameters": [
|
|
@@ -281,8 +265,10 @@
|
|
|
281
265
|
},
|
|
282
266
|
"/CreateManifest": {
|
|
283
267
|
"post": {
|
|
284
|
-
"tags": [
|
|
285
|
-
|
|
268
|
+
"tags": [
|
|
269
|
+
"Manifesting"
|
|
270
|
+
],
|
|
271
|
+
"description": "This method creates an end-of-day manifest and should be implemented by carrier apps that support\r\nend-of-day manifesting.",
|
|
286
272
|
"operationId": "Create Manifest",
|
|
287
273
|
"parameters": [
|
|
288
274
|
{
|
|
@@ -364,8 +350,10 @@
|
|
|
364
350
|
},
|
|
365
351
|
"/GetManifest": {
|
|
366
352
|
"post": {
|
|
367
|
-
"tags": [
|
|
368
|
-
|
|
353
|
+
"tags": [
|
|
354
|
+
"Manifesting"
|
|
355
|
+
],
|
|
356
|
+
"description": "This method retrieves the end-of-day manifest created by an earlier create manifest call.\r\nThe CreateManifestRequestId returned in the CreateManifest, is used to find the manifest.",
|
|
369
357
|
"operationId": "Get Manifest",
|
|
370
358
|
"parameters": [
|
|
371
359
|
{
|
|
@@ -379,7 +367,7 @@
|
|
|
379
367
|
}
|
|
380
368
|
],
|
|
381
369
|
"requestBody": {
|
|
382
|
-
"description": "An object containing information
|
|
370
|
+
"description": "An object containing information about the manifest request that is in progress to.",
|
|
383
371
|
"content": {
|
|
384
372
|
"application/json": {
|
|
385
373
|
"schema": {
|
|
@@ -433,7 +421,7 @@
|
|
|
433
421
|
"description": "Use this when the behavior is not supported or the behavior is not available for the user."
|
|
434
422
|
},
|
|
435
423
|
"200": {
|
|
436
|
-
"description": "This object model represents the response from a successful
|
|
424
|
+
"description": "This object model represents the response from a successful create manifest request.",
|
|
437
425
|
"content": {
|
|
438
426
|
"application/json": {
|
|
439
427
|
"schema": {
|
|
@@ -447,14 +435,16 @@
|
|
|
447
435
|
},
|
|
448
436
|
"/ValidateInboundData": {
|
|
449
437
|
"post": {
|
|
450
|
-
"tags": [
|
|
451
|
-
|
|
438
|
+
"tags": [
|
|
439
|
+
"Normalize Inbound Data"
|
|
440
|
+
],
|
|
441
|
+
"description": "This method validates and then returns the type of information contained in the inbound data,\r\nsuch as tracking information\r\n \r\nCarriers which support webhook based tracking or manifesting updates may choose to implement this endpoint\r\n \r\nNote: Changes made to the connection meta-data will not be saved if modified",
|
|
452
442
|
"operationId": "Validate Inbound Data",
|
|
453
443
|
"parameters": [
|
|
454
444
|
{
|
|
455
445
|
"name": "ShipStation-TransactionID",
|
|
456
446
|
"in": "header",
|
|
457
|
-
"description": "Unique transaction ID, use this transaction ID in your logs to correlate a
|
|
447
|
+
"description": "Unique transaction ID, use this transaction ID in your logs to correlate a\r\n request together.",
|
|
458
448
|
"schema": {
|
|
459
449
|
"type": "string",
|
|
460
450
|
"format": "uuid"
|
|
@@ -468,22 +458,7 @@
|
|
|
468
458
|
"schema": {
|
|
469
459
|
"$ref": "#/components/schemas/ValidateInboundDataRequest"
|
|
470
460
|
},
|
|
471
|
-
"example": {
|
|
472
|
-
"data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
|
|
473
|
-
"headers": {
|
|
474
|
-
"content-type": ["application/json"],
|
|
475
|
-
"X-Signature": [
|
|
476
|
-
"v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
|
|
477
|
-
"v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
|
|
478
|
-
]
|
|
479
|
-
},
|
|
480
|
-
"transaction_id": "00000000-0000-0000-0000-000000000000",
|
|
481
|
-
"metadata": {
|
|
482
|
-
"username": "auctane-next-day",
|
|
483
|
-
"password": "password!",
|
|
484
|
-
"meter_number": "8675309"
|
|
485
|
-
}
|
|
486
|
-
}
|
|
461
|
+
"example": {"data":"{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}","headers":{"content-type":["application/json"],"X-Signature":["v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b","v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"]},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
|
|
487
462
|
}
|
|
488
463
|
}
|
|
489
464
|
},
|
|
@@ -541,7 +516,7 @@
|
|
|
541
516
|
"examples": {
|
|
542
517
|
"Tracking": {
|
|
543
518
|
"summary": "Tracking",
|
|
544
|
-
"value": {
|
|
519
|
+
"value": {"content_types":["tracking"]}
|
|
545
520
|
}
|
|
546
521
|
}
|
|
547
522
|
}
|
|
@@ -552,14 +527,16 @@
|
|
|
552
527
|
},
|
|
553
528
|
"/NormalizeTrackingData": {
|
|
554
529
|
"post": {
|
|
555
|
-
"tags": [
|
|
556
|
-
|
|
530
|
+
"tags": [
|
|
531
|
+
"Normalize Inbound Data"
|
|
532
|
+
],
|
|
533
|
+
"description": "This method returns normalized tracking information for one or more shipments based on data send by the carrier\r\n \r\nCarriers which support webhook based tracking updates may choose to implement this endpoint\r\n \r\nNote: Changes made to the connection meta-data will not be saved if modified",
|
|
557
534
|
"operationId": "Normalize Tracking Data",
|
|
558
535
|
"parameters": [
|
|
559
536
|
{
|
|
560
537
|
"name": "ShipStation-TransactionID",
|
|
561
538
|
"in": "header",
|
|
562
|
-
"description": "Unique transaction ID, use this transaction ID in your logs to correlate a
|
|
539
|
+
"description": "Unique transaction ID, use this transaction ID in your logs to correlate a\r\n request together.",
|
|
563
540
|
"schema": {
|
|
564
541
|
"type": "string",
|
|
565
542
|
"format": "uuid"
|
|
@@ -573,22 +550,7 @@
|
|
|
573
550
|
"schema": {
|
|
574
551
|
"$ref": "#/components/schemas/NormalizeTrackingDataRequest"
|
|
575
552
|
},
|
|
576
|
-
"example": {
|
|
577
|
-
"data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
|
|
578
|
-
"headers": {
|
|
579
|
-
"content-type": ["application/json"],
|
|
580
|
-
"X-Signature": [
|
|
581
|
-
"v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
|
|
582
|
-
"v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
|
|
583
|
-
]
|
|
584
|
-
},
|
|
585
|
-
"transaction_id": "00000000-0000-0000-0000-000000000000",
|
|
586
|
-
"metadata": {
|
|
587
|
-
"username": "auctane-next-day",
|
|
588
|
-
"password": "password!",
|
|
589
|
-
"meter_number": "8675309"
|
|
590
|
-
}
|
|
591
|
-
}
|
|
553
|
+
"example": {"data":"{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}","headers":{"content-type":["application/json"],"X-Signature":["v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b","v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"]},"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
|
|
592
554
|
}
|
|
593
555
|
}
|
|
594
556
|
},
|
|
@@ -646,25 +608,7 @@
|
|
|
646
608
|
"examples": {
|
|
647
609
|
"Delivered": {
|
|
648
610
|
"summary": "Delivered",
|
|
649
|
-
"value": {
|
|
650
|
-
"tracking_info": [
|
|
651
|
-
{
|
|
652
|
-
"carrier_name": "UPS",
|
|
653
|
-
"tracking_number": "12345678901234567890",
|
|
654
|
-
"standardized_status_code": "DE",
|
|
655
|
-
"carrier_status_code": "11",
|
|
656
|
-
"carrier_status_description": "Delivered",
|
|
657
|
-
"estimated_delivery_datetime": "2021-08-11T00:00:00",
|
|
658
|
-
"actual_delivery_datetime": "2021-08-11T21:15:00Z",
|
|
659
|
-
"service": { "code": "03", "name": "UPS® Ground" },
|
|
660
|
-
"packaging": "package",
|
|
661
|
-
"package_count": 1,
|
|
662
|
-
"shipping_problem": false,
|
|
663
|
-
"carrierEnum": 0
|
|
664
|
-
}
|
|
665
|
-
],
|
|
666
|
-
"update_method": "append"
|
|
667
|
-
}
|
|
611
|
+
"value": {"tracking_info":[{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"shipping_problem":false,"carrierEnum":0}],"update_method":"append"}
|
|
668
612
|
}
|
|
669
613
|
}
|
|
670
614
|
}
|
|
@@ -675,7 +619,9 @@
|
|
|
675
619
|
},
|
|
676
620
|
"/CreateNotification": {
|
|
677
621
|
"post": {
|
|
678
|
-
"tags": [
|
|
622
|
+
"tags": [
|
|
623
|
+
"Shipment Notifications"
|
|
624
|
+
],
|
|
679
625
|
"operationId": "Create Notification",
|
|
680
626
|
"parameters": [
|
|
681
627
|
{
|
|
@@ -755,7 +701,9 @@
|
|
|
755
701
|
},
|
|
756
702
|
"/CancelNotification": {
|
|
757
703
|
"post": {
|
|
758
|
-
"tags": [
|
|
704
|
+
"tags": [
|
|
705
|
+
"Shipment Notifications"
|
|
706
|
+
],
|
|
759
707
|
"operationId": "Cancel Notification",
|
|
760
708
|
"parameters": [
|
|
761
709
|
{
|
|
@@ -835,7 +783,9 @@
|
|
|
835
783
|
},
|
|
836
784
|
"/SchedulePickup": {
|
|
837
785
|
"post": {
|
|
838
|
-
"tags": [
|
|
786
|
+
"tags": [
|
|
787
|
+
"Scheduled Pickups"
|
|
788
|
+
],
|
|
839
789
|
"description": "This method is used to schedule a pickup with a carrier.",
|
|
840
790
|
"operationId": "Schedule Adhoc Pickup",
|
|
841
791
|
"parameters": [
|
|
@@ -918,7 +868,9 @@
|
|
|
918
868
|
},
|
|
919
869
|
"/CancelPickup": {
|
|
920
870
|
"post": {
|
|
921
|
-
"tags": [
|
|
871
|
+
"tags": [
|
|
872
|
+
"Scheduled Pickups"
|
|
873
|
+
],
|
|
922
874
|
"operationId": "Cancel Adhoc Pickup",
|
|
923
875
|
"parameters": [
|
|
924
876
|
{
|
|
@@ -998,8 +950,10 @@
|
|
|
998
950
|
},
|
|
999
951
|
"/GetRates": {
|
|
1000
952
|
"post": {
|
|
1001
|
-
"tags": [
|
|
1002
|
-
|
|
953
|
+
"tags": [
|
|
954
|
+
"Rating"
|
|
955
|
+
],
|
|
956
|
+
"description": "This method calculates the shipping costs for a shipment, or multiple permutations of a shipment, to allow\r\nyour customers to select the best rate.\r\n \r\nMost carrier apps should implement this method, unless you don't support rating shipments.",
|
|
1003
957
|
"operationId": "Get Rates",
|
|
1004
958
|
"parameters": [
|
|
1005
959
|
{
|
|
@@ -1079,16 +1033,103 @@
|
|
|
1079
1033
|
}
|
|
1080
1034
|
}
|
|
1081
1035
|
},
|
|
1036
|
+
"/GetRelayPoints": {
|
|
1037
|
+
"post": {
|
|
1038
|
+
"tags": [
|
|
1039
|
+
"Relay Points"
|
|
1040
|
+
],
|
|
1041
|
+
"description": "This method gets carrier relay points based on search criteria.",
|
|
1042
|
+
"operationId": "Get Relay Points",
|
|
1043
|
+
"parameters": [
|
|
1044
|
+
{
|
|
1045
|
+
"name": "ShipStation-TransactionID",
|
|
1046
|
+
"in": "header",
|
|
1047
|
+
"description": "The transaction ID uniquely represents this request.",
|
|
1048
|
+
"schema": {
|
|
1049
|
+
"type": "string",
|
|
1050
|
+
"format": "uuid"
|
|
1051
|
+
}
|
|
1052
|
+
}
|
|
1053
|
+
],
|
|
1054
|
+
"requestBody": {
|
|
1055
|
+
"description": "An object containing search criteria for relay points.",
|
|
1056
|
+
"content": {
|
|
1057
|
+
"application/json": {
|
|
1058
|
+
"schema": {
|
|
1059
|
+
"$ref": "#/components/schemas/GetRelayPointsRequest"
|
|
1060
|
+
}
|
|
1061
|
+
}
|
|
1062
|
+
}
|
|
1063
|
+
},
|
|
1064
|
+
"responses": {
|
|
1065
|
+
"400": {
|
|
1066
|
+
"description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
|
|
1067
|
+
"content": {
|
|
1068
|
+
"application/json": {
|
|
1069
|
+
"schema": {
|
|
1070
|
+
"$ref": "#/components/schemas/BadRequestResponse"
|
|
1071
|
+
}
|
|
1072
|
+
}
|
|
1073
|
+
}
|
|
1074
|
+
},
|
|
1075
|
+
"401": {
|
|
1076
|
+
"description": "Use this to indicate an authentication or authorization error.",
|
|
1077
|
+
"content": {
|
|
1078
|
+
"application/json": {
|
|
1079
|
+
"schema": {
|
|
1080
|
+
"$ref": "#/components/schemas/UnauthorizedResponse"
|
|
1081
|
+
}
|
|
1082
|
+
}
|
|
1083
|
+
}
|
|
1084
|
+
},
|
|
1085
|
+
"500": {
|
|
1086
|
+
"description": "An unexpected error occurred in the carrier app.",
|
|
1087
|
+
"content": {
|
|
1088
|
+
"application/json": {
|
|
1089
|
+
"schema": {
|
|
1090
|
+
"$ref": "#/components/schemas/InternalServerErrorResponse"
|
|
1091
|
+
}
|
|
1092
|
+
}
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"520": {
|
|
1096
|
+
"description": "Use this when an error is the result of calling an external service, such as an API. This indicates that the error came from a downstream service rather than directly in your app.",
|
|
1097
|
+
"content": {
|
|
1098
|
+
"application/json": {
|
|
1099
|
+
"schema": {
|
|
1100
|
+
"$ref": "#/components/schemas/ExternalServerErrorResponse"
|
|
1101
|
+
}
|
|
1102
|
+
}
|
|
1103
|
+
}
|
|
1104
|
+
},
|
|
1105
|
+
"404": {
|
|
1106
|
+
"description": "Use this when the behavior is not supported or the behavior is not available for the user."
|
|
1107
|
+
},
|
|
1108
|
+
"200": {
|
|
1109
|
+
"description": "This object model represents the response from a successful get relay points request.",
|
|
1110
|
+
"content": {
|
|
1111
|
+
"application/json": {
|
|
1112
|
+
"schema": {
|
|
1113
|
+
"$ref": "#/components/schemas/GetRelayPointsResponse"
|
|
1114
|
+
}
|
|
1115
|
+
}
|
|
1116
|
+
}
|
|
1117
|
+
}
|
|
1118
|
+
}
|
|
1119
|
+
}
|
|
1120
|
+
},
|
|
1082
1121
|
"/Track": {
|
|
1083
1122
|
"post": {
|
|
1084
|
-
"tags": [
|
|
1085
|
-
|
|
1123
|
+
"tags": [
|
|
1124
|
+
"Tracking"
|
|
1125
|
+
],
|
|
1126
|
+
"description": "This method returns tracking information for a shipment, including each of the tracking events that\r\nhave occurred for the shipment.\r\n \r\nMost carrier applications should implement this method, unless you don't support tracking shipments.",
|
|
1086
1127
|
"operationId": "Track a Shipment",
|
|
1087
1128
|
"parameters": [
|
|
1088
1129
|
{
|
|
1089
1130
|
"name": "ShipStation-TransactionID",
|
|
1090
1131
|
"in": "header",
|
|
1091
|
-
"description": "Unique transaction ID, use this transaction ID in your logs to correlate a
|
|
1132
|
+
"description": "Unique transaction ID, use this transaction ID in your logs to correlate a\r\n request together.",
|
|
1092
1133
|
"schema": {
|
|
1093
1134
|
"type": "string",
|
|
1094
1135
|
"format": "uuid"
|
|
@@ -1102,32 +1143,7 @@
|
|
|
1102
1143
|
"schema": {
|
|
1103
1144
|
"$ref": "#/components/schemas/TrackingRequest"
|
|
1104
1145
|
},
|
|
1105
|
-
"example": {
|
|
1106
|
-
"tracking_number": "12345678901234567890",
|
|
1107
|
-
"is_return": false,
|
|
1108
|
-
"identifiers": [
|
|
1109
|
-
{
|
|
1110
|
-
"type": "tracking_number",
|
|
1111
|
-
"value": "12345678901234567890"
|
|
1112
|
-
},
|
|
1113
|
-
{
|
|
1114
|
-
"type": "carrier_transaction_id",
|
|
1115
|
-
"value": "US-12345678901234567890-1"
|
|
1116
|
-
}
|
|
1117
|
-
],
|
|
1118
|
-
"attributes": [
|
|
1119
|
-
{
|
|
1120
|
-
"type": "marketplace_order_token",
|
|
1121
|
-
"value": "123456abcdefg7890"
|
|
1122
|
-
}
|
|
1123
|
-
],
|
|
1124
|
-
"transaction_id": "00000000-0000-0000-0000-000000000000",
|
|
1125
|
-
"metadata": {
|
|
1126
|
-
"username": "auctane-next-day",
|
|
1127
|
-
"password": "password!",
|
|
1128
|
-
"meter_number": "8675309"
|
|
1129
|
-
}
|
|
1130
|
-
}
|
|
1146
|
+
"example": {"tracking_number":"12345678901234567890","is_return":false,"identifiers":[{"type":"tracking_number","value":"12345678901234567890"},{"type":"carrier_transaction_id","value":"US-12345678901234567890-1"}],"attributes":[{"type":"marketplace_order_token","value":"123456abcdefg7890"}],"transaction_id":"00000000-0000-0000-0000-000000000000","metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
|
|
1131
1147
|
}
|
|
1132
1148
|
}
|
|
1133
1149
|
},
|
|
@@ -1185,178 +1201,15 @@
|
|
|
1185
1201
|
"examples": {
|
|
1186
1202
|
"Delivered with Event History": {
|
|
1187
1203
|
"summary": "Delivered with Event History",
|
|
1188
|
-
"value": {
|
|
1189
|
-
"tracking_info": {
|
|
1190
|
-
"carrier_name": "UPS",
|
|
1191
|
-
"tracking_number": "12345678901234567890",
|
|
1192
|
-
"standardized_status_code": "DE",
|
|
1193
|
-
"carrier_status_code": "11",
|
|
1194
|
-
"carrier_status_description": "Delivered",
|
|
1195
|
-
"estimated_delivery_datetime": "2021-08-11T00:00:00",
|
|
1196
|
-
"actual_delivery_datetime": "2021-08-11T21:15:00Z",
|
|
1197
|
-
"weight": 500.0,
|
|
1198
|
-
"dimensions": {
|
|
1199
|
-
"length": 10.0,
|
|
1200
|
-
"width": 10.0,
|
|
1201
|
-
"height": 10.0
|
|
1202
|
-
},
|
|
1203
|
-
"service": { "code": "03", "name": "UPS® Ground" },
|
|
1204
|
-
"packaging": "package",
|
|
1205
|
-
"package_count": 1,
|
|
1206
|
-
"events": [
|
|
1207
|
-
{
|
|
1208
|
-
"event_datetime": "2021-08-08T21:15:00Z",
|
|
1209
|
-
"event_datetime_local": "2021-08-08T16:15:00",
|
|
1210
|
-
"event_code": "3",
|
|
1211
|
-
"description": "Order Processed: Ready for UPS",
|
|
1212
|
-
"city": "Austin",
|
|
1213
|
-
"state": "TX",
|
|
1214
|
-
"postal_code": "78756",
|
|
1215
|
-
"country": "US",
|
|
1216
|
-
"geo": { "lat": 30.31, "long": -97.74 },
|
|
1217
|
-
"status_code": "AC"
|
|
1218
|
-
},
|
|
1219
|
-
{
|
|
1220
|
-
"event_datetime": "2021-08-09T09:15:00Z",
|
|
1221
|
-
"event_datetime_local": "2021-08-09T04:15:00",
|
|
1222
|
-
"event_code": "5",
|
|
1223
|
-
"description": "In Transit",
|
|
1224
|
-
"city": "Austin",
|
|
1225
|
-
"state": "TX",
|
|
1226
|
-
"postal_code": "78756",
|
|
1227
|
-
"country": "US",
|
|
1228
|
-
"geo": { "lat": 30.2, "long": -97.66 },
|
|
1229
|
-
"status_code": "IT"
|
|
1230
|
-
},
|
|
1231
|
-
{
|
|
1232
|
-
"event_datetime": "2021-08-10T09:15:00Z",
|
|
1233
|
-
"event_datetime_local": "2021-08-10T04:15:00",
|
|
1234
|
-
"event_code": "6",
|
|
1235
|
-
"description": "On Vehicle for Delivery",
|
|
1236
|
-
"city": "Los Angeles",
|
|
1237
|
-
"state": "CA",
|
|
1238
|
-
"postal_code": "90045",
|
|
1239
|
-
"country": "US",
|
|
1240
|
-
"geo": { "lat": 33.95, "long": -118.38 },
|
|
1241
|
-
"status_code": "IT"
|
|
1242
|
-
},
|
|
1243
|
-
{
|
|
1244
|
-
"event_datetime": "2021-08-10T15:15:00Z",
|
|
1245
|
-
"event_datetime_local": "2021-08-10T10:15:00",
|
|
1246
|
-
"event_code": "21",
|
|
1247
|
-
"description": "On Vehicle for Delivery Today",
|
|
1248
|
-
"city": "Los Angeles",
|
|
1249
|
-
"state": "CA",
|
|
1250
|
-
"postal_code": "90045",
|
|
1251
|
-
"country": "US",
|
|
1252
|
-
"geo": { "lat": 33.95, "long": -118.38 },
|
|
1253
|
-
"status_code": "IT"
|
|
1254
|
-
},
|
|
1255
|
-
{
|
|
1256
|
-
"event_datetime": "2021-08-10T21:15:00Z",
|
|
1257
|
-
"event_datetime_local": "2021-08-10T16:15:00",
|
|
1258
|
-
"event_code": "22",
|
|
1259
|
-
"description": "First Attempt Made",
|
|
1260
|
-
"city": "El Segundo",
|
|
1261
|
-
"state": "CA",
|
|
1262
|
-
"postal_code": "90245",
|
|
1263
|
-
"country": "US",
|
|
1264
|
-
"geo": { "lat": 33.95, "long": -118.38 },
|
|
1265
|
-
"status_code": "AT"
|
|
1266
|
-
},
|
|
1267
|
-
{
|
|
1268
|
-
"event_datetime": "2021-08-11T03:15:00Z",
|
|
1269
|
-
"event_datetime_local": "2021-08-10T22:15:00",
|
|
1270
|
-
"event_code": "21",
|
|
1271
|
-
"description": "On Vehicle for Delivery Today",
|
|
1272
|
-
"city": "Los Angeles",
|
|
1273
|
-
"state": "CA",
|
|
1274
|
-
"postal_code": "90045",
|
|
1275
|
-
"country": "US",
|
|
1276
|
-
"geo": { "lat": 33.95, "long": -118.38 },
|
|
1277
|
-
"status_code": "IT"
|
|
1278
|
-
},
|
|
1279
|
-
{
|
|
1280
|
-
"event_datetime": "2021-08-11T21:15:00Z",
|
|
1281
|
-
"event_datetime_local": "2021-08-11T16:15:00",
|
|
1282
|
-
"event_code": "11",
|
|
1283
|
-
"description": "Delivered",
|
|
1284
|
-
"city": "El Segundo",
|
|
1285
|
-
"state": "CA",
|
|
1286
|
-
"postal_code": "90245",
|
|
1287
|
-
"country": "US",
|
|
1288
|
-
"geo": { "lat": 33.95, "long": -118.38 },
|
|
1289
|
-
"status_code": "DE"
|
|
1290
|
-
}
|
|
1291
|
-
],
|
|
1292
|
-
"shipping_problem": false,
|
|
1293
|
-
"carrierEnum": 0
|
|
1294
|
-
}
|
|
1295
|
-
}
|
|
1204
|
+
"value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-08T21:15:00Z","event_datetime_local":"2021-08-08T16:15:00","event_code":"3","description":"Order Processed: Ready for UPS","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.31,"long":-97.74},"status_code":"AC"},{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-10T09:15:00Z","event_datetime_local":"2021-08-10T04:15:00","event_code":"6","description":"On Vehicle for Delivery","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T15:15:00Z","event_datetime_local":"2021-08-10T10:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T21:15:00Z","event_datetime_local":"2021-08-10T16:15:00","event_code":"22","description":"First Attempt Made","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"AT"},{"event_datetime":"2021-08-11T03:15:00Z","event_datetime_local":"2021-08-10T22:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"11","description":"Delivered","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"DE"}],"shipping_problem":false,"carrierEnum":0}}
|
|
1296
1205
|
},
|
|
1297
1206
|
"Not Yet in System": {
|
|
1298
1207
|
"summary": "Not Yet in System",
|
|
1299
|
-
"value": {
|
|
1300
|
-
"tracking_info": {
|
|
1301
|
-
"carrier_name": "UPS",
|
|
1302
|
-
"tracking_number": "12345678901234567890",
|
|
1303
|
-
"standardized_status_code": "NY",
|
|
1304
|
-
"events": [],
|
|
1305
|
-
"shipping_problem": false,
|
|
1306
|
-
"carrierEnum": 0
|
|
1307
|
-
}
|
|
1308
|
-
}
|
|
1208
|
+
"value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"NY","events":[],"shipping_problem":false,"carrierEnum":0}}
|
|
1309
1209
|
},
|
|
1310
1210
|
"Fatal Exception": {
|
|
1311
1211
|
"summary": "Fatal Exception",
|
|
1312
|
-
"value": {
|
|
1313
|
-
"tracking_info": {
|
|
1314
|
-
"carrier_name": "UPS",
|
|
1315
|
-
"tracking_number": "12345678901234567890",
|
|
1316
|
-
"standardized_status_code": "EX",
|
|
1317
|
-
"carrier_status_code": "64",
|
|
1318
|
-
"carrier_status_description": "Delivery Refused",
|
|
1319
|
-
"estimated_delivery_datetime": "2021-08-11T00:00:00",
|
|
1320
|
-
"actual_delivery_datetime": "2021-08-11T21:15:00Z",
|
|
1321
|
-
"weight": 500.0,
|
|
1322
|
-
"dimensions": {
|
|
1323
|
-
"length": 10.0,
|
|
1324
|
-
"width": 10.0,
|
|
1325
|
-
"height": 10.0
|
|
1326
|
-
},
|
|
1327
|
-
"service": { "code": "03", "name": "UPS® Ground" },
|
|
1328
|
-
"packaging": "package",
|
|
1329
|
-
"package_count": 1,
|
|
1330
|
-
"events": [
|
|
1331
|
-
{
|
|
1332
|
-
"event_datetime": "2021-08-09T09:15:00Z",
|
|
1333
|
-
"event_datetime_local": "2021-08-09T04:15:00",
|
|
1334
|
-
"event_code": "5",
|
|
1335
|
-
"description": "In Transit",
|
|
1336
|
-
"city": "Austin",
|
|
1337
|
-
"state": "TX",
|
|
1338
|
-
"postal_code": "78756",
|
|
1339
|
-
"country": "US",
|
|
1340
|
-
"geo": { "lat": 30.2, "long": -97.66 },
|
|
1341
|
-
"status_code": "IT"
|
|
1342
|
-
},
|
|
1343
|
-
{
|
|
1344
|
-
"event_datetime": "2021-08-11T21:15:00Z",
|
|
1345
|
-
"event_datetime_local": "2021-08-11T16:15:00",
|
|
1346
|
-
"event_code": "59",
|
|
1347
|
-
"description": "Delivery Refused",
|
|
1348
|
-
"city": "El Segundo",
|
|
1349
|
-
"state": "CA",
|
|
1350
|
-
"postal_code": "90245",
|
|
1351
|
-
"country": "US",
|
|
1352
|
-
"geo": { "lat": 33.95, "long": -118.38 },
|
|
1353
|
-
"status_code": "EX"
|
|
1354
|
-
}
|
|
1355
|
-
],
|
|
1356
|
-
"shipping_problem": false,
|
|
1357
|
-
"carrierEnum": 0
|
|
1358
|
-
}
|
|
1359
|
-
}
|
|
1212
|
+
"value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"EX","carrier_status_code":"64","carrier_status_description":"Delivery Refused","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"59","description":"Delivery Refused","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"EX"}],"shipping_problem":false,"carrierEnum":0}}
|
|
1360
1213
|
}
|
|
1361
1214
|
}
|
|
1362
1215
|
}
|
|
@@ -1449,7 +1302,13 @@
|
|
|
1449
1302
|
"additionalProperties": false
|
|
1450
1303
|
},
|
|
1451
1304
|
"AddressResidentialIndicator": {
|
|
1452
|
-
"enum": [
|
|
1305
|
+
"enum": [
|
|
1306
|
+
"unknown",
|
|
1307
|
+
"yes",
|
|
1308
|
+
"no",
|
|
1309
|
+
"commercial",
|
|
1310
|
+
"residential"
|
|
1311
|
+
],
|
|
1453
1312
|
"type": "string"
|
|
1454
1313
|
},
|
|
1455
1314
|
"AdvancedOptions": {
|
|
@@ -1477,7 +1336,7 @@
|
|
|
1477
1336
|
"type": "string",
|
|
1478
1337
|
"description": "Decimal currency value, as a string."
|
|
1479
1338
|
},
|
|
1480
|
-
"
|
|
1339
|
+
"currency": {
|
|
1481
1340
|
"type": "string",
|
|
1482
1341
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
1483
1342
|
}
|
|
@@ -1486,8 +1345,8 @@
|
|
|
1486
1345
|
"nullable": true
|
|
1487
1346
|
}
|
|
1488
1347
|
},
|
|
1489
|
-
"additionalProperties": {},
|
|
1490
|
-
"description": "This is a schemaless object. It is for open ended customizations unique to particular carriers. The documented
|
|
1348
|
+
"additionalProperties": { },
|
|
1349
|
+
"description": "This is a schemaless object. It is for open ended customizations unique to particular carriers. The documented\r\nkeys are some common options shared by many carriers, but are not definitive. Advanced options you support will\r\nbe defined in ShipEngine. If the field is absent it should be interpreted as the default value for any\r\napplicable options, e.g. false for booleans."
|
|
1491
1350
|
},
|
|
1492
1351
|
"Authorization": {
|
|
1493
1352
|
"type": "object",
|
|
@@ -1531,7 +1390,7 @@
|
|
|
1531
1390
|
},
|
|
1532
1391
|
"metadata": {
|
|
1533
1392
|
"type": "object",
|
|
1534
|
-
"additionalProperties": {},
|
|
1393
|
+
"additionalProperties": { },
|
|
1535
1394
|
"nullable": true
|
|
1536
1395
|
}
|
|
1537
1396
|
},
|
|
@@ -1542,8 +1401,8 @@
|
|
|
1542
1401
|
"properties": {
|
|
1543
1402
|
"metadata": {
|
|
1544
1403
|
"type": "object",
|
|
1545
|
-
"additionalProperties": {},
|
|
1546
|
-
"description": "This is an optional schemaless object that you may return with a successful response. Anything returned
|
|
1404
|
+
"additionalProperties": { },
|
|
1405
|
+
"description": "This is an optional schemaless object that you may return with a successful response. Anything returned\r\nunder this key will be included in all future requests. For example, you may store additional static\r\nproperties about the end user or their connection to the carrier. The maximum storage size\r\nfor data under this key is 4KB.",
|
|
1547
1406
|
"nullable": true
|
|
1548
1407
|
}
|
|
1549
1408
|
},
|
|
@@ -1599,7 +1458,7 @@
|
|
|
1599
1458
|
"type": "string",
|
|
1600
1459
|
"description": "Decimal currency value, as a string."
|
|
1601
1460
|
},
|
|
1602
|
-
"
|
|
1461
|
+
"currency": {
|
|
1603
1462
|
"type": "string",
|
|
1604
1463
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
1605
1464
|
}
|
|
@@ -1623,15 +1482,19 @@
|
|
|
1623
1482
|
},
|
|
1624
1483
|
"account_number": {
|
|
1625
1484
|
"type": "string",
|
|
1626
|
-
"description": "Specified if there is an account number associated with the Bill To Party, and the Bill To Party is
|
|
1485
|
+
"description": "Specified if there is an account number associated with the Bill To Party, and the Bill To Party is\r\nnot the account holder.",
|
|
1627
1486
|
"nullable": true
|
|
1628
1487
|
}
|
|
1629
1488
|
},
|
|
1630
1489
|
"additionalProperties": false,
|
|
1631
|
-
"description": "Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
|
|
1490
|
+
"description": "Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party\r\nother than the shipper (the shipper is considered the default party responsible). CarrierApi.Common.Request.CarrierApi.Common.Models.BillTo\r\nextends CarrierApi.Common.Models.Addresses.AddressBase since address fields are often required when associating billing to\r\nanother account. Additionally, this allows for a contact to be specified, if necessary."
|
|
1632
1491
|
},
|
|
1633
1492
|
"BillToParty": {
|
|
1634
|
-
"enum": [
|
|
1493
|
+
"enum": [
|
|
1494
|
+
"shipper",
|
|
1495
|
+
"recipient",
|
|
1496
|
+
"third_party_account"
|
|
1497
|
+
],
|
|
1635
1498
|
"type": "string",
|
|
1636
1499
|
"description": "The type of party responsible for a given category of charges associated with a shipment, such as shipping charges or import duties."
|
|
1637
1500
|
},
|
|
@@ -1699,7 +1562,7 @@
|
|
|
1699
1562
|
"properties": {
|
|
1700
1563
|
"message": {
|
|
1701
1564
|
"type": "string",
|
|
1702
|
-
"description": "User facing text describing the cancellation process. May be left
|
|
1565
|
+
"description": "User facing text describing the cancellation process. May be left \r\nblank to present a default value.",
|
|
1703
1566
|
"nullable": true
|
|
1704
1567
|
},
|
|
1705
1568
|
"errors": {
|
|
@@ -1707,7 +1570,7 @@
|
|
|
1707
1570
|
"items": {
|
|
1708
1571
|
"type": "string"
|
|
1709
1572
|
},
|
|
1710
|
-
"description": "A list of errors preventing this notification from being cancelled
|
|
1573
|
+
"description": "A list of errors preventing this notification from being cancelled.\r\nIf no errors are returned the void is considered successful. If \r\nany errors are returned the void is considered failed.",
|
|
1711
1574
|
"nullable": true
|
|
1712
1575
|
}
|
|
1713
1576
|
},
|
|
@@ -1812,12 +1675,12 @@
|
|
|
1812
1675
|
"properties": {
|
|
1813
1676
|
"service_code": {
|
|
1814
1677
|
"type": "string",
|
|
1815
|
-
"description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed
|
|
1678
|
+
"description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed\r\nto you will be configured in ShipEngine.",
|
|
1816
1679
|
"nullable": true
|
|
1817
1680
|
},
|
|
1818
1681
|
"ship_datetime": {
|
|
1819
1682
|
"type": "string",
|
|
1820
|
-
"description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the
|
|
1683
|
+
"description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.",
|
|
1821
1684
|
"format": "date-time"
|
|
1822
1685
|
},
|
|
1823
1686
|
"confirmation": {
|
|
@@ -1831,7 +1694,7 @@
|
|
|
1831
1694
|
},
|
|
1832
1695
|
"is_test_label": {
|
|
1833
1696
|
"type": "boolean",
|
|
1834
|
-
"description": "Whether this request is the result of a test. When true the request must not result in any financial charges
|
|
1697
|
+
"description": "Whether this request is the result of a test. When true the request must not result in any financial charges\r\nto any party. If the field is absent it should be interpreted as false"
|
|
1835
1698
|
},
|
|
1836
1699
|
"advanced_options": {
|
|
1837
1700
|
"$ref": "#/components/schemas/AdvancedOptions"
|
|
@@ -1841,7 +1704,7 @@
|
|
|
1841
1704
|
},
|
|
1842
1705
|
"is_return_label": {
|
|
1843
1706
|
"type": "boolean",
|
|
1844
|
-
"description": "Whether this label is to return a previously shipped package. If the field is absent it should be
|
|
1707
|
+
"description": "Whether this label is to return a previously shipped package. If the field is absent it should be\r\ninterpreted as false."
|
|
1845
1708
|
},
|
|
1846
1709
|
"packages": {
|
|
1847
1710
|
"type": "array",
|
|
@@ -1860,12 +1723,15 @@
|
|
|
1860
1723
|
"pickup_location": {
|
|
1861
1724
|
"$ref": "#/components/schemas/PudoLocation"
|
|
1862
1725
|
},
|
|
1726
|
+
"relay_points": {
|
|
1727
|
+
"$ref": "#/components/schemas/RelayPointDetails"
|
|
1728
|
+
},
|
|
1863
1729
|
"ship_from_display": {
|
|
1864
1730
|
"$ref": "#/components/schemas/ShipFromDisplay"
|
|
1865
1731
|
},
|
|
1866
1732
|
"next_day": {
|
|
1867
1733
|
"type": "boolean",
|
|
1868
|
-
"description": "Whether this shipment is expected to use a next day service class. If the field is absent it
|
|
1734
|
+
"description": "Whether this shipment is expected to use a next day service class. If the field is absent it\r\nshould be interpreted as false",
|
|
1869
1735
|
"nullable": true
|
|
1870
1736
|
},
|
|
1871
1737
|
"international": {
|
|
@@ -1889,7 +1755,7 @@
|
|
|
1889
1755
|
"items": {
|
|
1890
1756
|
"$ref": "#/components/schemas/Document"
|
|
1891
1757
|
},
|
|
1892
|
-
"description": "Attachments that may be required to be sent to the carrier, in particular customs documents or
|
|
1758
|
+
"description": "Attachments that may be required to be sent to the carrier, in particular customs documents or\r\ncommercial invoices.",
|
|
1893
1759
|
"nullable": true
|
|
1894
1760
|
},
|
|
1895
1761
|
"bill_shipping_to": {
|
|
@@ -1924,7 +1790,7 @@
|
|
|
1924
1790
|
"items": {
|
|
1925
1791
|
"$ref": "#/components/schemas/Document"
|
|
1926
1792
|
},
|
|
1927
|
-
"description": "Shipment level documents should be used if documents are not returned at a package level
|
|
1793
|
+
"description": "Shipment level documents should be used if documents are not returned at a package level.\r\nDO NOT include duplicate documents intentionally, a document should only be added to the CreateLabelResponse\r\nor to the LabelPackage.",
|
|
1928
1794
|
"nullable": true
|
|
1929
1795
|
},
|
|
1930
1796
|
"packages": {
|
|
@@ -1932,7 +1798,7 @@
|
|
|
1932
1798
|
"items": {
|
|
1933
1799
|
"$ref": "#/components/schemas/LabelPackage"
|
|
1934
1800
|
},
|
|
1935
|
-
"description": "Package information returned for each requested package in the shipment
|
|
1801
|
+
"description": "Package information returned for each requested package in the shipment.\r\nNote: The order of the packages returned should match the order of the packages in the request.",
|
|
1936
1802
|
"nullable": true
|
|
1937
1803
|
},
|
|
1938
1804
|
"billing_line_items": {
|
|
@@ -1945,7 +1811,7 @@
|
|
|
1945
1811
|
},
|
|
1946
1812
|
"tracking_number": {
|
|
1947
1813
|
"type": "string",
|
|
1948
|
-
"description": "The carrier specific tracking identifier for this shipment; if a multi-package shipment, this should be
|
|
1814
|
+
"description": "The carrier specific tracking identifier for this shipment; if a multi-package shipment, this should be\r\nthe lead tracking number.",
|
|
1949
1815
|
"nullable": true
|
|
1950
1816
|
},
|
|
1951
1817
|
"trackable": {
|
|
@@ -1963,7 +1829,7 @@
|
|
|
1963
1829
|
},
|
|
1964
1830
|
"estimated_delivery_datetime": {
|
|
1965
1831
|
"type": "string",
|
|
1966
|
-
"description": "The estimated date and time for when the shipment will be delivered. Formatted per the
|
|
1832
|
+
"description": "The estimated date and time for when the shipment will be delivered. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec.",
|
|
1967
1833
|
"format": "date-time",
|
|
1968
1834
|
"nullable": true,
|
|
1969
1835
|
"example": "1937-01-01T12:00:27.87+00:20"
|
|
@@ -1978,35 +1844,14 @@
|
|
|
1978
1844
|
},
|
|
1979
1845
|
"delivery_window": {
|
|
1980
1846
|
"$ref": "#/components/schemas/TimeWindow"
|
|
1847
|
+
},
|
|
1848
|
+
"relay_points": {
|
|
1849
|
+
"$ref": "#/components/schemas/RelayPointDetails"
|
|
1981
1850
|
}
|
|
1982
1851
|
},
|
|
1983
1852
|
"additionalProperties": false,
|
|
1984
1853
|
"description": "This model represents the response from a successful create label request."
|
|
1985
1854
|
},
|
|
1986
|
-
"GetManifestRequest": {
|
|
1987
|
-
"type": "object",
|
|
1988
|
-
"allOf": [
|
|
1989
|
-
{
|
|
1990
|
-
"$ref": "#/components/schemas/BaseRequest"
|
|
1991
|
-
}
|
|
1992
|
-
],
|
|
1993
|
-
"properties": {
|
|
1994
|
-
"manifest_request_id":{
|
|
1995
|
-
"type": "integer"
|
|
1996
|
-
},
|
|
1997
|
-
"manifest_identifiers": {
|
|
1998
|
-
"type": "array",
|
|
1999
|
-
"items": {
|
|
2000
|
-
"$ref": "#/components/schemas/Identifier"
|
|
2001
|
-
}
|
|
2002
|
-
},
|
|
2003
|
-
"return_immediately": {
|
|
2004
|
-
"type": "boolean"
|
|
2005
|
-
}
|
|
2006
|
-
},
|
|
2007
|
-
"additionalProperties": false,
|
|
2008
|
-
"description": "This model represents the request payload needed to retrieve a previously created manifest."
|
|
2009
|
-
},
|
|
2010
1855
|
"CreateManifestRequest": {
|
|
2011
1856
|
"type": "object",
|
|
2012
1857
|
"allOf": [
|
|
@@ -2021,7 +1866,7 @@
|
|
|
2021
1866
|
"included_labels": {
|
|
2022
1867
|
"type": "array",
|
|
2023
1868
|
"items": {
|
|
2024
|
-
"$ref": "#/components/schemas/
|
|
1869
|
+
"$ref": "#/components/schemas/ManifestRequestShipment"
|
|
2025
1870
|
},
|
|
2026
1871
|
"description": "The shipments to include in the manifest. There should be at least one shipment included in a manifest.",
|
|
2027
1872
|
"nullable": true
|
|
@@ -2029,20 +1874,20 @@
|
|
|
2029
1874
|
"excluded_labels": {
|
|
2030
1875
|
"type": "array",
|
|
2031
1876
|
"items": {
|
|
2032
|
-
"$ref": "#/components/schemas/
|
|
1877
|
+
"$ref": "#/components/schemas/ManifestRequestShipment"
|
|
2033
1878
|
},
|
|
2034
1879
|
"description": "The shipments to exclude from the manifest.",
|
|
2035
1880
|
"nullable": true
|
|
2036
1881
|
},
|
|
2037
1882
|
"open_datetime": {
|
|
2038
1883
|
"type": "string",
|
|
2039
|
-
"description": "The date and time of the earliest shipment being manifested. Formatted per the
|
|
1884
|
+
"description": "The date and time of the earliest shipment being manifested. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec",
|
|
2040
1885
|
"format": "date-time",
|
|
2041
1886
|
"nullable": true
|
|
2042
1887
|
},
|
|
2043
1888
|
"close_datetime": {
|
|
2044
1889
|
"type": "string",
|
|
2045
|
-
"description": "The date and time of the last shipment being manifested. Formatted per the
|
|
1890
|
+
"description": "The date and time of the last shipment being manifested. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec",
|
|
2046
1891
|
"format": "date-time"
|
|
2047
1892
|
},
|
|
2048
1893
|
"advanced_options": {
|
|
@@ -2071,6 +1916,41 @@
|
|
|
2071
1916
|
},
|
|
2072
1917
|
"description": "The manifests created from this request. It should contain either a href or data, but not both.",
|
|
2073
1918
|
"nullable": true
|
|
1919
|
+
},
|
|
1920
|
+
"errors": {
|
|
1921
|
+
"type": "array",
|
|
1922
|
+
"items": {
|
|
1923
|
+
"$ref": "#/components/schemas/ManifestError"
|
|
1924
|
+
},
|
|
1925
|
+
"description": "Errored shipments if some but not all shipments were successfully manifested",
|
|
1926
|
+
"nullable": true
|
|
1927
|
+
},
|
|
1928
|
+
"manifest_status": {
|
|
1929
|
+
"$ref": "#/components/schemas/ManifestStatus"
|
|
1930
|
+
},
|
|
1931
|
+
"manifest_request_id": {
|
|
1932
|
+
"type": "integer",
|
|
1933
|
+
"description": "Manifest request identifier.",
|
|
1934
|
+
"format": "int64",
|
|
1935
|
+
"nullable": true
|
|
1936
|
+
},
|
|
1937
|
+
"total_shipments": {
|
|
1938
|
+
"type": "integer",
|
|
1939
|
+
"description": "Total number of shipments requested for manifesting.",
|
|
1940
|
+
"format": "int32",
|
|
1941
|
+
"nullable": true
|
|
1942
|
+
},
|
|
1943
|
+
"total_invalid": {
|
|
1944
|
+
"type": "integer",
|
|
1945
|
+
"description": "Total number of shipments that failed to manifest.",
|
|
1946
|
+
"format": "int32",
|
|
1947
|
+
"nullable": true
|
|
1948
|
+
},
|
|
1949
|
+
"manifest_identifiers": {
|
|
1950
|
+
"type": "object",
|
|
1951
|
+
"additionalProperties": { },
|
|
1952
|
+
"description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
|
|
1953
|
+
"nullable": true
|
|
2074
1954
|
}
|
|
2075
1955
|
},
|
|
2076
1956
|
"additionalProperties": false,
|
|
@@ -2089,6 +1969,9 @@
|
|
|
2089
1969
|
},
|
|
2090
1970
|
"create_label_request": {
|
|
2091
1971
|
"$ref": "#/components/schemas/CreateLabelRequest"
|
|
1972
|
+
},
|
|
1973
|
+
"advanced_options": {
|
|
1974
|
+
"$ref": "#/components/schemas/AdvancedOptions"
|
|
2092
1975
|
}
|
|
2093
1976
|
},
|
|
2094
1977
|
"additionalProperties": false,
|
|
@@ -2106,6 +1989,14 @@
|
|
|
2106
1989
|
"type": "string",
|
|
2107
1990
|
"description": "The id of the successfully created notification.",
|
|
2108
1991
|
"nullable": true
|
|
1992
|
+
},
|
|
1993
|
+
"billing_line_items": {
|
|
1994
|
+
"type": "array",
|
|
1995
|
+
"items": {
|
|
1996
|
+
"$ref": "#/components/schemas/BillingLineItem"
|
|
1997
|
+
},
|
|
1998
|
+
"description": "Individual Billing Line items for the label.",
|
|
1999
|
+
"nullable": true
|
|
2109
2000
|
}
|
|
2110
2001
|
},
|
|
2111
2002
|
"additionalProperties": false,
|
|
@@ -2124,7 +2015,7 @@
|
|
|
2124
2015
|
}
|
|
2125
2016
|
},
|
|
2126
2017
|
"additionalProperties": false,
|
|
2127
|
-
"description": "The credentials that will be used to access this carrier's services. These will be sent as a
|
|
2018
|
+
"description": "The credentials that will be used to access this carrier's services. These will be sent as a\r\nBasic Authorization header with all future requests."
|
|
2128
2019
|
},
|
|
2129
2020
|
"Customs": {
|
|
2130
2021
|
"type": "object",
|
|
@@ -2149,12 +2040,12 @@
|
|
|
2149
2040
|
"type": "string",
|
|
2150
2041
|
"description": "Decimal currency value, as a string."
|
|
2151
2042
|
},
|
|
2152
|
-
"
|
|
2043
|
+
"currency": {
|
|
2153
2044
|
"type": "string",
|
|
2154
2045
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2155
2046
|
}
|
|
2156
2047
|
},
|
|
2157
|
-
"description": "Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed
|
|
2048
|
+
"description": "Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed\r\nto the shipper.",
|
|
2158
2049
|
"nullable": true
|
|
2159
2050
|
},
|
|
2160
2051
|
"duties_paid": {
|
|
@@ -2163,12 +2054,12 @@
|
|
|
2163
2054
|
"type": "string",
|
|
2164
2055
|
"description": "Decimal currency value, as a string."
|
|
2165
2056
|
},
|
|
2166
|
-
"
|
|
2057
|
+
"currency": {
|
|
2167
2058
|
"type": "string",
|
|
2168
2059
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2169
2060
|
}
|
|
2170
2061
|
},
|
|
2171
|
-
"description": "The amount of duties paid by the shipper, if any. This is generally only necessary for DDP
|
|
2062
|
+
"description": "The amount of duties paid by the shipper, if any. This is generally only necessary for DDP\r\n(bill_duties_to_sender) shipments.",
|
|
2172
2063
|
"nullable": true
|
|
2173
2064
|
},
|
|
2174
2065
|
"bill_duties_to": {
|
|
@@ -2192,7 +2083,7 @@
|
|
|
2192
2083
|
"properties": {
|
|
2193
2084
|
"description": {
|
|
2194
2085
|
"type": "string",
|
|
2195
|
-
"description": "A user specified free form string describing this customs item. If the field is absent the user has
|
|
2086
|
+
"description": "A user specified free form string describing this customs item. If the field is absent the user has\r\nnot specified a description.",
|
|
2196
2087
|
"nullable": true
|
|
2197
2088
|
},
|
|
2198
2089
|
"quantity": {
|
|
@@ -2206,12 +2097,12 @@
|
|
|
2206
2097
|
"type": "string",
|
|
2207
2098
|
"description": "Decimal currency value, as a string."
|
|
2208
2099
|
},
|
|
2209
|
-
"
|
|
2100
|
+
"currency": {
|
|
2210
2101
|
"type": "string",
|
|
2211
2102
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2212
2103
|
}
|
|
2213
2104
|
},
|
|
2214
|
-
"description": "The user specified declared customs value of this customs item. Generally, this value needs to be greater
|
|
2105
|
+
"description": "The user specified declared customs value of this customs item. Generally, this value needs to be greater\r\nthan 0 to be accepted through customs.",
|
|
2215
2106
|
"nullable": true
|
|
2216
2107
|
},
|
|
2217
2108
|
"country_of_origin": {
|
|
@@ -2242,7 +2133,10 @@
|
|
|
2242
2133
|
"description": "This model represents the customs declaration for a single item."
|
|
2243
2134
|
},
|
|
2244
2135
|
"CustomsNonDelivery": {
|
|
2245
|
-
"enum": [
|
|
2136
|
+
"enum": [
|
|
2137
|
+
"return_to_sender",
|
|
2138
|
+
"treat_as_abandoned"
|
|
2139
|
+
],
|
|
2246
2140
|
"type": "string",
|
|
2247
2141
|
"description": "What to do if the shipment is undeliverable."
|
|
2248
2142
|
},
|
|
@@ -2325,7 +2219,10 @@
|
|
|
2325
2219
|
"description": "This model represents the measurements for dimensions."
|
|
2326
2220
|
},
|
|
2327
2221
|
"DimensionUnit": {
|
|
2328
|
-
"enum": [
|
|
2222
|
+
"enum": [
|
|
2223
|
+
"inches",
|
|
2224
|
+
"centimeters"
|
|
2225
|
+
],
|
|
2329
2226
|
"type": "string",
|
|
2330
2227
|
"description": "This model represents the supported units for dimensions."
|
|
2331
2228
|
},
|
|
@@ -2337,7 +2234,7 @@
|
|
|
2337
2234
|
"items": {
|
|
2338
2235
|
"$ref": "#/components/schemas/DocumentType"
|
|
2339
2236
|
},
|
|
2340
|
-
"description": "The document type(s) being returned. In most cases this is just a single document type; however, some
|
|
2237
|
+
"description": "The document type(s) being returned. In most cases this is just a single document type; however, some\r\ncarriers return multiple document types in the same PDF or ZPL.",
|
|
2341
2238
|
"nullable": true
|
|
2342
2239
|
},
|
|
2343
2240
|
"data": {
|
|
@@ -2353,7 +2250,11 @@
|
|
|
2353
2250
|
"description": "Container for a document."
|
|
2354
2251
|
},
|
|
2355
2252
|
"DocumentFormat": {
|
|
2356
|
-
"enum": [
|
|
2253
|
+
"enum": [
|
|
2254
|
+
"PDF",
|
|
2255
|
+
"ZPL",
|
|
2256
|
+
"PNG"
|
|
2257
|
+
],
|
|
2357
2258
|
"type": "string"
|
|
2358
2259
|
},
|
|
2359
2260
|
"DocumentType": {
|
|
@@ -2373,7 +2274,7 @@
|
|
|
2373
2274
|
"items": {
|
|
2374
2275
|
"$ref": "#/components/schemas/DetailedError"
|
|
2375
2276
|
},
|
|
2376
|
-
"description": "A list of detailed errors that occurred for this request
|
|
2277
|
+
"description": "A list of detailed errors that occurred for this request.\r\nRemove all personally identifiable information.",
|
|
2377
2278
|
"nullable": true
|
|
2378
2279
|
}
|
|
2379
2280
|
},
|
|
@@ -2401,7 +2302,7 @@
|
|
|
2401
2302
|
}
|
|
2402
2303
|
],
|
|
2403
2304
|
"additionalProperties": false,
|
|
2404
|
-
"description": "This provides any additional forms that go with the label. For example, customs forms. Exactly one of the
|
|
2305
|
+
"description": "This provides any additional forms that go with the label. For example, customs forms. Exactly one of the\r\nkeys should be populated. Set href is the forms should be downloaded separately. Set data if the\r\nforms are returned directly in the response."
|
|
2405
2306
|
},
|
|
2406
2307
|
"FulfillmentPlanDetails": {
|
|
2407
2308
|
"type": "object",
|
|
@@ -2462,6 +2363,34 @@
|
|
|
2462
2363
|
"additionalProperties": false,
|
|
2463
2364
|
"description": "This contains information about the fulfillment plan for a set of items."
|
|
2464
2365
|
},
|
|
2366
|
+
"GetManifestRequest": {
|
|
2367
|
+
"type": "object",
|
|
2368
|
+
"allOf": [
|
|
2369
|
+
{
|
|
2370
|
+
"$ref": "#/components/schemas/BaseRequest"
|
|
2371
|
+
}
|
|
2372
|
+
],
|
|
2373
|
+
"properties": {
|
|
2374
|
+
"manifest_request_id": {
|
|
2375
|
+
"type": "integer",
|
|
2376
|
+
"description": "Manifest request identifier.",
|
|
2377
|
+
"format": "int64",
|
|
2378
|
+
"nullable": true
|
|
2379
|
+
},
|
|
2380
|
+
"return_immediately": {
|
|
2381
|
+
"type": "boolean",
|
|
2382
|
+
"description": "Return immediately after checking status.\r\nFull manifest creation can take up to 2 minutes.\r\nSet to false to allow additional checks before timeout."
|
|
2383
|
+
},
|
|
2384
|
+
"manifest_identifiers": {
|
|
2385
|
+
"type": "object",
|
|
2386
|
+
"additionalProperties": { },
|
|
2387
|
+
"description": "Carrier specific data needed to retrieve Manifest results",
|
|
2388
|
+
"nullable": true
|
|
2389
|
+
}
|
|
2390
|
+
},
|
|
2391
|
+
"additionalProperties": false,
|
|
2392
|
+
"description": "This model represents the request payload needed to get a manifest that has already been created."
|
|
2393
|
+
},
|
|
2465
2394
|
"GetRatesRequest": {
|
|
2466
2395
|
"type": "object",
|
|
2467
2396
|
"allOf": [
|
|
@@ -2472,12 +2401,12 @@
|
|
|
2472
2401
|
"properties": {
|
|
2473
2402
|
"service_code": {
|
|
2474
2403
|
"type": "string",
|
|
2475
|
-
"description": "If present, a specific service is being requested, and that is the only rate required to fulfill the request
|
|
2404
|
+
"description": "If present, a specific service is being requested, and that is the only rate required to fulfill the request.\r\nThe service code uniquely identifies a shipping service that you offer.\r\nWhich service codes can be passed to you will be configured in ShipEngine.",
|
|
2476
2405
|
"nullable": true
|
|
2477
2406
|
},
|
|
2478
2407
|
"ship_datetime": {
|
|
2479
2408
|
"type": "string",
|
|
2480
|
-
"description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the
|
|
2409
|
+
"description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.",
|
|
2481
2410
|
"format": "date-time"
|
|
2482
2411
|
},
|
|
2483
2412
|
"confirmation": {
|
|
@@ -2491,7 +2420,7 @@
|
|
|
2491
2420
|
},
|
|
2492
2421
|
"is_return_label": {
|
|
2493
2422
|
"type": "boolean",
|
|
2494
|
-
"description": "Whether this label is to return a previously shipped package. If the field is absent it should be
|
|
2423
|
+
"description": "Whether this label is to return a previously shipped package. If the field is absent it should be\r\ninterpreted as false."
|
|
2495
2424
|
},
|
|
2496
2425
|
"packages": {
|
|
2497
2426
|
"type": "array",
|
|
@@ -2520,7 +2449,7 @@
|
|
|
2520
2449
|
},
|
|
2521
2450
|
"next_day": {
|
|
2522
2451
|
"type": "boolean",
|
|
2523
|
-
"description": "Whether this shipment is expected to use a next day service class. If the field is absent it
|
|
2452
|
+
"description": "Whether this shipment is expected to use a next day service class. If the field is absent it\r\nshould be interpreted as false",
|
|
2524
2453
|
"nullable": true
|
|
2525
2454
|
},
|
|
2526
2455
|
"fulfillment_plan_details": {
|
|
@@ -2549,13 +2478,59 @@
|
|
|
2549
2478
|
"items": {
|
|
2550
2479
|
"$ref": "#/components/schemas/Rate"
|
|
2551
2480
|
},
|
|
2552
|
-
"description": "A list of rates for shipping services. If you use service codes there may be exactly one rate returned for
|
|
2481
|
+
"description": "A list of rates for shipping services. If you use service codes there may be exactly one rate returned for\r\nthe requested service. If you use service codes there may be more than one rate to provide additional\r\noptions. If you don't use service codes there may be one or more rates. If you don't provide real time\r\nrates you should return a single hard coded zero value rate.",
|
|
2553
2482
|
"nullable": true
|
|
2554
2483
|
}
|
|
2555
2484
|
},
|
|
2556
2485
|
"additionalProperties": false,
|
|
2557
2486
|
"description": "This model represents the response for a get rates request."
|
|
2558
2487
|
},
|
|
2488
|
+
"GetRelayPointsRequest": {
|
|
2489
|
+
"type": "object",
|
|
2490
|
+
"allOf": [
|
|
2491
|
+
{
|
|
2492
|
+
"$ref": "#/components/schemas/BaseRequest"
|
|
2493
|
+
}
|
|
2494
|
+
],
|
|
2495
|
+
"properties": {
|
|
2496
|
+
"service_code": {
|
|
2497
|
+
"type": "string",
|
|
2498
|
+
"description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed\r\nto you will be configured in ShipEngine.",
|
|
2499
|
+
"nullable": true
|
|
2500
|
+
},
|
|
2501
|
+
"city_locality": {
|
|
2502
|
+
"type": "string",
|
|
2503
|
+
"description": "The city locality to use when searching for available relay points.",
|
|
2504
|
+
"nullable": true
|
|
2505
|
+
},
|
|
2506
|
+
"postal_code": {
|
|
2507
|
+
"type": "string",
|
|
2508
|
+
"description": "The postal code to use when searching for available relay points.",
|
|
2509
|
+
"nullable": true
|
|
2510
|
+
},
|
|
2511
|
+
"country_code": {
|
|
2512
|
+
"type": "string",
|
|
2513
|
+
"description": "The two character country code to use when searching for available relay points. The codes are specified by ISO 3166-1 alpha-2.",
|
|
2514
|
+
"nullable": true
|
|
2515
|
+
}
|
|
2516
|
+
},
|
|
2517
|
+
"additionalProperties": false,
|
|
2518
|
+
"description": "This model represents the payload sent to get relay points based on the provided search criteria."
|
|
2519
|
+
},
|
|
2520
|
+
"GetRelayPointsResponse": {
|
|
2521
|
+
"type": "object",
|
|
2522
|
+
"properties": {
|
|
2523
|
+
"relay_points": {
|
|
2524
|
+
"type": "array",
|
|
2525
|
+
"items": {
|
|
2526
|
+
"$ref": "#/components/schemas/RelayPoint"
|
|
2527
|
+
},
|
|
2528
|
+
"nullable": true
|
|
2529
|
+
}
|
|
2530
|
+
},
|
|
2531
|
+
"additionalProperties": false,
|
|
2532
|
+
"description": "Basic structure for a response to get relay points"
|
|
2533
|
+
},
|
|
2559
2534
|
"Identifier": {
|
|
2560
2535
|
"type": "object",
|
|
2561
2536
|
"properties": {
|
|
@@ -2574,11 +2549,18 @@
|
|
|
2574
2549
|
"description": "A key value pair, allowing custom properties to be stored."
|
|
2575
2550
|
},
|
|
2576
2551
|
"InboundDataContentTypes": {
|
|
2577
|
-
"enum": [
|
|
2552
|
+
"enum": [
|
|
2553
|
+
"tracking"
|
|
2554
|
+
],
|
|
2578
2555
|
"type": "string"
|
|
2579
2556
|
},
|
|
2580
2557
|
"InsuranceProviders": {
|
|
2581
|
-
"enum": [
|
|
2558
|
+
"enum": [
|
|
2559
|
+
"None",
|
|
2560
|
+
"ShipStation",
|
|
2561
|
+
"Carrier",
|
|
2562
|
+
"External"
|
|
2563
|
+
],
|
|
2582
2564
|
"type": "string"
|
|
2583
2565
|
},
|
|
2584
2566
|
"InternalServerErrorResponse": {
|
|
@@ -2599,10 +2581,13 @@
|
|
|
2599
2581
|
}
|
|
2600
2582
|
],
|
|
2601
2583
|
"additionalProperties": false,
|
|
2602
|
-
"description": "This object provides the requested label that was just created. Exactly one of the keys should be populated
|
|
2584
|
+
"description": "This object provides the requested label that was just created. Exactly one of the keys should be populated.\r\nSet href if the label should be downloaded separately. Set data if the label is returned directly in\r\nthe response."
|
|
2603
2585
|
},
|
|
2604
2586
|
"LabelLayouts": {
|
|
2605
|
-
"enum": [
|
|
2587
|
+
"enum": [
|
|
2588
|
+
"4x6",
|
|
2589
|
+
"letter"
|
|
2590
|
+
],
|
|
2606
2591
|
"type": "string"
|
|
2607
2592
|
},
|
|
2608
2593
|
"LabelMessage": {
|
|
@@ -2644,7 +2629,7 @@
|
|
|
2644
2629
|
"items": {
|
|
2645
2630
|
"$ref": "#/components/schemas/Document"
|
|
2646
2631
|
},
|
|
2647
|
-
"description": "Documents associated with this package, if documents are not specified at a package level, use the
|
|
2632
|
+
"description": "Documents associated with this package, if documents are not specified at a package level, use the\r\nDocuments array at the CarrierApi.Common.Response.CreateLabelResponse level.",
|
|
2648
2633
|
"nullable": true
|
|
2649
2634
|
}
|
|
2650
2635
|
},
|
|
@@ -2680,11 +2665,65 @@
|
|
|
2680
2665
|
},
|
|
2681
2666
|
"document_download": {
|
|
2682
2667
|
"$ref": "#/components/schemas/ResourceDownload"
|
|
2668
|
+
},
|
|
2669
|
+
"manifest_request_shipment_ids": {
|
|
2670
|
+
"type": "array",
|
|
2671
|
+
"items": {
|
|
2672
|
+
"type": "string",
|
|
2673
|
+
"format": "uuid"
|
|
2674
|
+
},
|
|
2675
|
+
"description": "The manifest request shipment id's associated with this manifest document",
|
|
2676
|
+
"nullable": true
|
|
2683
2677
|
}
|
|
2684
2678
|
},
|
|
2685
2679
|
"additionalProperties": false,
|
|
2686
2680
|
"description": "This model represents a single manifest created with a shipping provider."
|
|
2687
2681
|
},
|
|
2682
|
+
"ManifestError": {
|
|
2683
|
+
"type": "object",
|
|
2684
|
+
"properties": {
|
|
2685
|
+
"manifest_request_shipment_ids": {
|
|
2686
|
+
"type": "array",
|
|
2687
|
+
"items": {
|
|
2688
|
+
"type": "string",
|
|
2689
|
+
"format": "uuid"
|
|
2690
|
+
},
|
|
2691
|
+
"description": "Manifest shipment request ID's associated with this error message",
|
|
2692
|
+
"nullable": true
|
|
2693
|
+
},
|
|
2694
|
+
"message": {
|
|
2695
|
+
"type": "string",
|
|
2696
|
+
"description": "Error message",
|
|
2697
|
+
"nullable": true
|
|
2698
|
+
}
|
|
2699
|
+
},
|
|
2700
|
+
"additionalProperties": false
|
|
2701
|
+
},
|
|
2702
|
+
"ManifestRequestShipment": {
|
|
2703
|
+
"type": "object",
|
|
2704
|
+
"allOf": [
|
|
2705
|
+
{
|
|
2706
|
+
"$ref": "#/components/schemas/ShippedShipment"
|
|
2707
|
+
}
|
|
2708
|
+
],
|
|
2709
|
+
"properties": {
|
|
2710
|
+
"manifest_request_shipment_id": {
|
|
2711
|
+
"type": "string",
|
|
2712
|
+
"description": "Uniquely identifies this request to manifest a shipment. Used to identify which shipments could not be manifested.",
|
|
2713
|
+
"format": "uuid"
|
|
2714
|
+
}
|
|
2715
|
+
},
|
|
2716
|
+
"additionalProperties": false
|
|
2717
|
+
},
|
|
2718
|
+
"ManifestStatus": {
|
|
2719
|
+
"enum": [
|
|
2720
|
+
"unknown",
|
|
2721
|
+
"in_progress",
|
|
2722
|
+
"completed",
|
|
2723
|
+
"failed"
|
|
2724
|
+
],
|
|
2725
|
+
"type": "string"
|
|
2726
|
+
},
|
|
2688
2727
|
"NormalizeTrackingDataRequest": {
|
|
2689
2728
|
"type": "object",
|
|
2690
2729
|
"allOf": [
|
|
@@ -2736,6 +2775,41 @@
|
|
|
2736
2775
|
"additionalProperties": false,
|
|
2737
2776
|
"description": "This model represents the successful response from a normalize tracking data request."
|
|
2738
2777
|
},
|
|
2778
|
+
"OpeningTimes": {
|
|
2779
|
+
"type": "object",
|
|
2780
|
+
"properties": {
|
|
2781
|
+
"monday": {
|
|
2782
|
+
"type": "string",
|
|
2783
|
+
"nullable": true
|
|
2784
|
+
},
|
|
2785
|
+
"tuesday": {
|
|
2786
|
+
"type": "string",
|
|
2787
|
+
"nullable": true
|
|
2788
|
+
},
|
|
2789
|
+
"wednesday": {
|
|
2790
|
+
"type": "string",
|
|
2791
|
+
"nullable": true
|
|
2792
|
+
},
|
|
2793
|
+
"thursday": {
|
|
2794
|
+
"type": "string",
|
|
2795
|
+
"nullable": true
|
|
2796
|
+
},
|
|
2797
|
+
"friday": {
|
|
2798
|
+
"type": "string",
|
|
2799
|
+
"nullable": true
|
|
2800
|
+
},
|
|
2801
|
+
"saturday": {
|
|
2802
|
+
"type": "string",
|
|
2803
|
+
"nullable": true
|
|
2804
|
+
},
|
|
2805
|
+
"sunday": {
|
|
2806
|
+
"type": "string",
|
|
2807
|
+
"nullable": true
|
|
2808
|
+
}
|
|
2809
|
+
},
|
|
2810
|
+
"additionalProperties": false,
|
|
2811
|
+
"description": "The times each day that the relay point is open, for example: \"11:00-13:00, 14:30-19:30\""
|
|
2812
|
+
},
|
|
2739
2813
|
"Package": {
|
|
2740
2814
|
"type": "object",
|
|
2741
2815
|
"properties": {
|
|
@@ -2756,7 +2830,7 @@
|
|
|
2756
2830
|
"type": "string",
|
|
2757
2831
|
"description": "Decimal currency value, as a string."
|
|
2758
2832
|
},
|
|
2759
|
-
"
|
|
2833
|
+
"currency": {
|
|
2760
2834
|
"type": "string",
|
|
2761
2835
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2762
2836
|
}
|
|
@@ -2938,7 +3012,7 @@
|
|
|
2938
3012
|
"properties": {
|
|
2939
3013
|
"service_code": {
|
|
2940
3014
|
"type": "string",
|
|
2941
|
-
"description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed
|
|
3015
|
+
"description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed\r\nto you will be configured in ShipEngine.\r\nIf this field is missing, the rate will be discarded.",
|
|
2942
3016
|
"nullable": true
|
|
2943
3017
|
},
|
|
2944
3018
|
"package_type": {
|
|
@@ -2948,13 +3022,13 @@
|
|
|
2948
3022
|
},
|
|
2949
3023
|
"ship_datetime": {
|
|
2950
3024
|
"type": "string",
|
|
2951
|
-
"description": "When the package should ship for this rate to be valid. ** This differs from previous documentation
|
|
3025
|
+
"description": "When the package should ship for this rate to be valid. ** This differs from previous documentation\r\nFormatted per the https://tools.ietf.org/html/rfc3339 spec. Must be in UTC.",
|
|
2952
3026
|
"format": "date-time",
|
|
2953
3027
|
"nullable": true
|
|
2954
3028
|
},
|
|
2955
3029
|
"estimated_delivery_datetime": {
|
|
2956
3030
|
"type": "string",
|
|
2957
|
-
"description": "When the package(s) in this shipment are expected to arrive at their destination
|
|
3031
|
+
"description": "When the package(s) in this shipment are expected to arrive at their destination.\r\nFormatted per https://tools.ietf.org/html/rfc3339. Must be in UTC.",
|
|
2958
3032
|
"format": "date-time",
|
|
2959
3033
|
"nullable": true
|
|
2960
3034
|
},
|
|
@@ -2979,7 +3053,7 @@
|
|
|
2979
3053
|
"items": {
|
|
2980
3054
|
"type": "string"
|
|
2981
3055
|
},
|
|
2982
|
-
"description": "A list of discrete warnings. This should be data the end user needs to be aware of
|
|
3056
|
+
"description": "A list of discrete warnings. This should be data the end user needs to be aware of.\r\nThese should not stop the request from succeeding, or a label being purchased with this rate.",
|
|
2983
3057
|
"nullable": true
|
|
2984
3058
|
},
|
|
2985
3059
|
"negotiated_rate": {
|
|
@@ -3029,8 +3103,8 @@
|
|
|
3029
3103
|
"properties": {
|
|
3030
3104
|
"registration_info": {
|
|
3031
3105
|
"type": "object",
|
|
3032
|
-
"additionalProperties": {},
|
|
3033
|
-
"description": "This is a schemaless object used to contain any required fields for validating a users credentials or
|
|
3106
|
+
"additionalProperties": { },
|
|
3107
|
+
"description": "This is a schemaless object used to contain any required fields for validating a users credentials or\r\nregistering a new account. These fields will be custom to the shipping service provider, and will be\r\ncollected via a form and sent over as key value pairs.",
|
|
3034
3108
|
"nullable": true
|
|
3035
3109
|
}
|
|
3036
3110
|
},
|
|
@@ -3045,14 +3119,94 @@
|
|
|
3045
3119
|
},
|
|
3046
3120
|
"metadata": {
|
|
3047
3121
|
"type": "object",
|
|
3048
|
-
"additionalProperties": {},
|
|
3049
|
-
"description": "This is an optional schemaless object that should be returned for persisted auth and user information
|
|
3122
|
+
"additionalProperties": { },
|
|
3123
|
+
"description": "This is an optional schemaless object that should be returned for persisted auth and user information.\r\nAnything returned under this key will be included in all future requests. For example, you may store\r\nadditional static properties about the end user or their connection to the carrier. The maximum\r\nstorage size for data under this key is 4KB.",
|
|
3050
3124
|
"nullable": true
|
|
3051
3125
|
}
|
|
3052
3126
|
},
|
|
3053
3127
|
"additionalProperties": false,
|
|
3054
3128
|
"description": "This model represents the successful response for a registration request."
|
|
3055
3129
|
},
|
|
3130
|
+
"RelayPoint": {
|
|
3131
|
+
"type": "object",
|
|
3132
|
+
"allOf": [
|
|
3133
|
+
{
|
|
3134
|
+
"$ref": "#/components/schemas/RelayPointAddress"
|
|
3135
|
+
}
|
|
3136
|
+
],
|
|
3137
|
+
"properties": {
|
|
3138
|
+
"phone": {
|
|
3139
|
+
"type": "string",
|
|
3140
|
+
"nullable": true
|
|
3141
|
+
},
|
|
3142
|
+
"longitude": {
|
|
3143
|
+
"type": "integer",
|
|
3144
|
+
"format": "int32",
|
|
3145
|
+
"nullable": true
|
|
3146
|
+
},
|
|
3147
|
+
"latitude": {
|
|
3148
|
+
"type": "integer",
|
|
3149
|
+
"format": "int32",
|
|
3150
|
+
"nullable": true
|
|
3151
|
+
},
|
|
3152
|
+
"opening_times": {
|
|
3153
|
+
"$ref": "#/components/schemas/OpeningTimes"
|
|
3154
|
+
}
|
|
3155
|
+
},
|
|
3156
|
+
"additionalProperties": false,
|
|
3157
|
+
"description": "Basic structure for a relay point"
|
|
3158
|
+
},
|
|
3159
|
+
"RelayPointAddress": {
|
|
3160
|
+
"type": "object",
|
|
3161
|
+
"properties": {
|
|
3162
|
+
"relay_point_id": {
|
|
3163
|
+
"type": "string",
|
|
3164
|
+
"nullable": true
|
|
3165
|
+
},
|
|
3166
|
+
"company_name": {
|
|
3167
|
+
"type": "string",
|
|
3168
|
+
"nullable": true
|
|
3169
|
+
},
|
|
3170
|
+
"address_lines": {
|
|
3171
|
+
"type": "array",
|
|
3172
|
+
"items": {
|
|
3173
|
+
"type": "string"
|
|
3174
|
+
},
|
|
3175
|
+
"nullable": true
|
|
3176
|
+
},
|
|
3177
|
+
"city_locality": {
|
|
3178
|
+
"type": "string",
|
|
3179
|
+
"nullable": true
|
|
3180
|
+
},
|
|
3181
|
+
"state_province": {
|
|
3182
|
+
"type": "string",
|
|
3183
|
+
"nullable": true
|
|
3184
|
+
},
|
|
3185
|
+
"postal_code": {
|
|
3186
|
+
"type": "string",
|
|
3187
|
+
"nullable": true
|
|
3188
|
+
},
|
|
3189
|
+
"country_code": {
|
|
3190
|
+
"type": "string",
|
|
3191
|
+
"nullable": true
|
|
3192
|
+
}
|
|
3193
|
+
},
|
|
3194
|
+
"additionalProperties": false,
|
|
3195
|
+
"description": "The address information corresponding to a specific relay point"
|
|
3196
|
+
},
|
|
3197
|
+
"RelayPointDetails": {
|
|
3198
|
+
"type": "object",
|
|
3199
|
+
"properties": {
|
|
3200
|
+
"ship_to": {
|
|
3201
|
+
"$ref": "#/components/schemas/RelayPointAddress"
|
|
3202
|
+
},
|
|
3203
|
+
"ship_from": {
|
|
3204
|
+
"$ref": "#/components/schemas/RelayPointAddress"
|
|
3205
|
+
}
|
|
3206
|
+
},
|
|
3207
|
+
"additionalProperties": false,
|
|
3208
|
+
"description": "Details of the relay points used for the shipment"
|
|
3209
|
+
},
|
|
3056
3210
|
"ResourceDownload": {
|
|
3057
3211
|
"type": "object",
|
|
3058
3212
|
"properties": {
|
|
@@ -3075,7 +3229,7 @@
|
|
|
3075
3229
|
"properties": {
|
|
3076
3230
|
"rma_number": {
|
|
3077
3231
|
"type": "string",
|
|
3078
|
-
"description": "A return merchandise authorization (RMA) is an associated number assigned to process the return, this
|
|
3232
|
+
"description": "A return merchandise authorization (RMA) is an associated number assigned to process the return, this\r\nnumber is often printed on the label, and used when the original shipper processes the inbound return.",
|
|
3079
3233
|
"nullable": true
|
|
3080
3234
|
}
|
|
3081
3235
|
},
|
|
@@ -3195,7 +3349,7 @@
|
|
|
3195
3349
|
}
|
|
3196
3350
|
],
|
|
3197
3351
|
"additionalProperties": false,
|
|
3198
|
-
"description": "The address that should be displayed as the return address, only if the shipping provider supports
|
|
3352
|
+
"description": "The address that should be displayed as the return address, only if the shipping provider supports\r\nthis functionality."
|
|
3199
3353
|
},
|
|
3200
3354
|
"ShipmentIdentifier": {
|
|
3201
3355
|
"type": "object",
|
|
@@ -3285,7 +3439,7 @@
|
|
|
3285
3439
|
}
|
|
3286
3440
|
},
|
|
3287
3441
|
"additionalProperties": false,
|
|
3288
|
-
"description": "This model represents a shipment that has already been shipped, and contains
|
|
3442
|
+
"description": "This model represents a shipment that has already been shipped, and contains\r\nsummary information about the shipment."
|
|
3289
3443
|
},
|
|
3290
3444
|
"ShipTo": {
|
|
3291
3445
|
"type": "object",
|
|
@@ -3326,12 +3480,29 @@
|
|
|
3326
3480
|
"description": "A list of standard error identifiers for errors the module can return"
|
|
3327
3481
|
},
|
|
3328
3482
|
"StandardizedStatusCodes": {
|
|
3329
|
-
"enum": [
|
|
3483
|
+
"enum": [
|
|
3484
|
+
"UN",
|
|
3485
|
+
"AC",
|
|
3486
|
+
"IT",
|
|
3487
|
+
"DE",
|
|
3488
|
+
"EX",
|
|
3489
|
+
"AT",
|
|
3490
|
+
"NY"
|
|
3491
|
+
],
|
|
3330
3492
|
"type": "string",
|
|
3331
|
-
"description": "This represents the ShipEngine supported status codes for a shipment
|
|
3493
|
+
"description": "This represents the ShipEngine supported status codes for a shipment.\r\nUN - Unknown\r\nAC - Accepted\r\nIT - In Transit\r\nDE - Delivered\r\nEX - Exception\r\nAT - Delivery Attempted\r\nNY - Not Yet In System"
|
|
3332
3494
|
},
|
|
3333
3495
|
"TaxIdentificationType": {
|
|
3334
|
-
"enum": [
|
|
3496
|
+
"enum": [
|
|
3497
|
+
"tin",
|
|
3498
|
+
"ein",
|
|
3499
|
+
"ssn",
|
|
3500
|
+
"vat",
|
|
3501
|
+
"eori",
|
|
3502
|
+
"ioss",
|
|
3503
|
+
"pan",
|
|
3504
|
+
"voec"
|
|
3505
|
+
],
|
|
3335
3506
|
"type": "string",
|
|
3336
3507
|
"description": "Specifies the supported tax identification types."
|
|
3337
3508
|
},
|
|
@@ -3631,7 +3802,10 @@
|
|
|
3631
3802
|
"description": "This model represents a response that the request was unauthorized to perform some action."
|
|
3632
3803
|
},
|
|
3633
3804
|
"UpdateMethods": {
|
|
3634
|
-
"enum": [
|
|
3805
|
+
"enum": [
|
|
3806
|
+
"append",
|
|
3807
|
+
"replace"
|
|
3808
|
+
],
|
|
3635
3809
|
"type": "string"
|
|
3636
3810
|
},
|
|
3637
3811
|
"ValidateInboundDataRequest": {
|
|
@@ -3660,7 +3834,7 @@
|
|
|
3660
3834
|
}
|
|
3661
3835
|
},
|
|
3662
3836
|
"additionalProperties": false,
|
|
3663
|
-
"description": "This model represents the payload that is sent to validate inbound data requests (e.g. webhooks) and determine
|
|
3837
|
+
"description": "This model represents the payload that is sent to validate inbound data requests (e.g. webhooks) and determine\r\nwhat type information is contained in the data."
|
|
3664
3838
|
},
|
|
3665
3839
|
"ValidateInboundDataResponse": {
|
|
3666
3840
|
"type": "object",
|
|
@@ -3760,7 +3934,7 @@
|
|
|
3760
3934
|
"items": {
|
|
3761
3935
|
"type": "string"
|
|
3762
3936
|
},
|
|
3763
|
-
"description": "A list of errors preventing this label from being voided. If no errors are returned the void is considered
|
|
3937
|
+
"description": "A list of errors preventing this label from being voided. If no errors are returned the void is considered\r\nsuccessful. If any errors are returned the void is considered failed.",
|
|
3764
3938
|
"nullable": true
|
|
3765
3939
|
},
|
|
3766
3940
|
"billing_line_items": {
|
|
@@ -3801,7 +3975,12 @@
|
|
|
3801
3975
|
"description": "This model represents the weight of a package in its original unit, ounces, and grams."
|
|
3802
3976
|
},
|
|
3803
3977
|
"WeightUnit": {
|
|
3804
|
-
"enum": [
|
|
3978
|
+
"enum": [
|
|
3979
|
+
"grams",
|
|
3980
|
+
"ounces",
|
|
3981
|
+
"kilograms",
|
|
3982
|
+
"pounds"
|
|
3983
|
+
],
|
|
3805
3984
|
"type": "string",
|
|
3806
3985
|
"description": "This model describes the possible units of weight."
|
|
3807
3986
|
}
|
|
@@ -3816,6 +3995,10 @@
|
|
|
3816
3995
|
"name": "Rating",
|
|
3817
3996
|
"description": ""
|
|
3818
3997
|
},
|
|
3998
|
+
{
|
|
3999
|
+
"name": "Relay Points",
|
|
4000
|
+
"description": "Relay points are the ship from/to locations used with Pickup/Drop Off (PUDO) shipments"
|
|
4001
|
+
},
|
|
3819
4002
|
{
|
|
3820
4003
|
"name": "Labels",
|
|
3821
4004
|
"description": ""
|
|
@@ -3834,11 +4017,11 @@
|
|
|
3834
4017
|
},
|
|
3835
4018
|
{
|
|
3836
4019
|
"name": "Shipment Notifications",
|
|
3837
|
-
"description": "Shipment notifications were designed to notify a Pickup/Drop Off (PUDO) provider that a parcel is enroute to their location.
|
|
4020
|
+
"description": "Shipment notifications were designed to notify a Pickup/Drop Off (PUDO) provider that a parcel is enroute to their location. These endpoints allow for carrier agnostic PUDO locations to expect and plan for the arrival of the parcel."
|
|
3838
4021
|
},
|
|
3839
4022
|
{
|
|
3840
4023
|
"name": "Normalize Inbound Data",
|
|
3841
4024
|
"description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
|
|
3842
4025
|
}
|
|
3843
4026
|
]
|
|
3844
|
-
}
|
|
4027
|
+
}
|