@shipengine/connect-carrier-api 2.4.2 → 2.4.3
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/package.json +1 -1
- package/spec.json +562 -82
package/package.json
CHANGED
package/spec.json
CHANGED
|
@@ -3,12 +3,14 @@
|
|
|
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.0"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
10
10
|
"post": {
|
|
11
|
-
"tags": [
|
|
11
|
+
"tags": [
|
|
12
|
+
"Account Setup"
|
|
13
|
+
],
|
|
12
14
|
"description": "This method is used to authenticate with your application. It is responsible for verifying the supplied user credentials and establishing or renewing a connection. The authentication information will be stored in the metadata object and will be included in all request bodies. All applications must implement the Register method.",
|
|
13
15
|
"operationId": "Register",
|
|
14
16
|
"parameters": [
|
|
@@ -115,7 +117,9 @@
|
|
|
115
117
|
},
|
|
116
118
|
"/CreateLabel": {
|
|
117
119
|
"post": {
|
|
118
|
-
"tags": [
|
|
120
|
+
"tags": [
|
|
121
|
+
"Labels"
|
|
122
|
+
],
|
|
119
123
|
"description": "This method creates a new label.",
|
|
120
124
|
"operationId": "Create a Label",
|
|
121
125
|
"parameters": [
|
|
@@ -198,7 +202,9 @@
|
|
|
198
202
|
},
|
|
199
203
|
"/VoidLabels": {
|
|
200
204
|
"post": {
|
|
201
|
-
"tags": [
|
|
205
|
+
"tags": [
|
|
206
|
+
"Labels"
|
|
207
|
+
],
|
|
202
208
|
"description": "This method is used to void a previously created labels.",
|
|
203
209
|
"operationId": "Void a Label",
|
|
204
210
|
"parameters": [
|
|
@@ -281,7 +287,9 @@
|
|
|
281
287
|
},
|
|
282
288
|
"/CreateManifest": {
|
|
283
289
|
"post": {
|
|
284
|
-
"tags": [
|
|
290
|
+
"tags": [
|
|
291
|
+
"Manifesting"
|
|
292
|
+
],
|
|
285
293
|
"description": "This method creates an end-of-day manifest and should be implemented by carrier apps that support end-of-day manifesting.",
|
|
286
294
|
"operationId": "Create Manifest",
|
|
287
295
|
"parameters": [
|
|
@@ -364,8 +372,10 @@
|
|
|
364
372
|
},
|
|
365
373
|
"/GetManifest": {
|
|
366
374
|
"post": {
|
|
367
|
-
"tags": [
|
|
368
|
-
|
|
375
|
+
"tags": [
|
|
376
|
+
"Manifesting"
|
|
377
|
+
],
|
|
378
|
+
"description": "This method retrieves the end-of-day manifest created by an earlier create manifest call. The CreateManifestRequestId returned in the CreateManifest, is used to find the manifest.",
|
|
369
379
|
"operationId": "Get Manifest",
|
|
370
380
|
"parameters": [
|
|
371
381
|
{
|
|
@@ -379,7 +389,7 @@
|
|
|
379
389
|
}
|
|
380
390
|
],
|
|
381
391
|
"requestBody": {
|
|
382
|
-
"description": "An object containing information
|
|
392
|
+
"description": "An object containing information about the manifest request that is in progress to.",
|
|
383
393
|
"content": {
|
|
384
394
|
"application/json": {
|
|
385
395
|
"schema": {
|
|
@@ -433,7 +443,7 @@
|
|
|
433
443
|
"description": "Use this when the behavior is not supported or the behavior is not available for the user."
|
|
434
444
|
},
|
|
435
445
|
"200": {
|
|
436
|
-
"description": "This object model represents the response from a successful
|
|
446
|
+
"description": "This object model represents the response from a successful create manifest request.",
|
|
437
447
|
"content": {
|
|
438
448
|
"application/json": {
|
|
439
449
|
"schema": {
|
|
@@ -447,8 +457,10 @@
|
|
|
447
457
|
},
|
|
448
458
|
"/ValidateInboundData": {
|
|
449
459
|
"post": {
|
|
450
|
-
"tags": [
|
|
451
|
-
|
|
460
|
+
"tags": [
|
|
461
|
+
"Normalize Inbound Data"
|
|
462
|
+
],
|
|
463
|
+
"description": "This method validates and then returns the type of information contained in the inbound data, such as tracking information Carriers which support webhook based tracking or manifesting updates may choose to implement this endpoint Note: Changes made to the connection meta-data will not be saved if modified",
|
|
452
464
|
"operationId": "Validate Inbound Data",
|
|
453
465
|
"parameters": [
|
|
454
466
|
{
|
|
@@ -471,7 +483,9 @@
|
|
|
471
483
|
"example": {
|
|
472
484
|
"data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
|
|
473
485
|
"headers": {
|
|
474
|
-
"content-type": [
|
|
486
|
+
"content-type": [
|
|
487
|
+
"application/json"
|
|
488
|
+
],
|
|
475
489
|
"X-Signature": [
|
|
476
490
|
"v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
|
|
477
491
|
"v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
|
|
@@ -541,7 +555,11 @@
|
|
|
541
555
|
"examples": {
|
|
542
556
|
"Tracking": {
|
|
543
557
|
"summary": "Tracking",
|
|
544
|
-
"value": {
|
|
558
|
+
"value": {
|
|
559
|
+
"content_types": [
|
|
560
|
+
"tracking"
|
|
561
|
+
]
|
|
562
|
+
}
|
|
545
563
|
}
|
|
546
564
|
}
|
|
547
565
|
}
|
|
@@ -552,8 +570,10 @@
|
|
|
552
570
|
},
|
|
553
571
|
"/NormalizeTrackingData": {
|
|
554
572
|
"post": {
|
|
555
|
-
"tags": [
|
|
556
|
-
|
|
573
|
+
"tags": [
|
|
574
|
+
"Normalize Inbound Data"
|
|
575
|
+
],
|
|
576
|
+
"description": "This method returns normalized tracking information for one or more shipments based on data send by the carrier Carriers which support webhook based tracking updates may choose to implement this endpoint Note: Changes made to the connection meta-data will not be saved if modified",
|
|
557
577
|
"operationId": "Normalize Tracking Data",
|
|
558
578
|
"parameters": [
|
|
559
579
|
{
|
|
@@ -576,7 +596,9 @@
|
|
|
576
596
|
"example": {
|
|
577
597
|
"data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
|
|
578
598
|
"headers": {
|
|
579
|
-
"content-type": [
|
|
599
|
+
"content-type": [
|
|
600
|
+
"application/json"
|
|
601
|
+
],
|
|
580
602
|
"X-Signature": [
|
|
581
603
|
"v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
|
|
582
604
|
"v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
|
|
@@ -656,7 +678,10 @@
|
|
|
656
678
|
"carrier_status_description": "Delivered",
|
|
657
679
|
"estimated_delivery_datetime": "2021-08-11T00:00:00",
|
|
658
680
|
"actual_delivery_datetime": "2021-08-11T21:15:00Z",
|
|
659
|
-
"service": {
|
|
681
|
+
"service": {
|
|
682
|
+
"code": "03",
|
|
683
|
+
"name": "UPS® Ground"
|
|
684
|
+
},
|
|
660
685
|
"packaging": "package",
|
|
661
686
|
"package_count": 1,
|
|
662
687
|
"shipping_problem": false,
|
|
@@ -675,7 +700,9 @@
|
|
|
675
700
|
},
|
|
676
701
|
"/CreateNotification": {
|
|
677
702
|
"post": {
|
|
678
|
-
"tags": [
|
|
703
|
+
"tags": [
|
|
704
|
+
"Shipment Notifications"
|
|
705
|
+
],
|
|
679
706
|
"operationId": "Create Notification",
|
|
680
707
|
"parameters": [
|
|
681
708
|
{
|
|
@@ -755,7 +782,9 @@
|
|
|
755
782
|
},
|
|
756
783
|
"/CancelNotification": {
|
|
757
784
|
"post": {
|
|
758
|
-
"tags": [
|
|
785
|
+
"tags": [
|
|
786
|
+
"Shipment Notifications"
|
|
787
|
+
],
|
|
759
788
|
"operationId": "Cancel Notification",
|
|
760
789
|
"parameters": [
|
|
761
790
|
{
|
|
@@ -835,7 +864,9 @@
|
|
|
835
864
|
},
|
|
836
865
|
"/SchedulePickup": {
|
|
837
866
|
"post": {
|
|
838
|
-
"tags": [
|
|
867
|
+
"tags": [
|
|
868
|
+
"Scheduled Pickups"
|
|
869
|
+
],
|
|
839
870
|
"description": "This method is used to schedule a pickup with a carrier.",
|
|
840
871
|
"operationId": "Schedule Adhoc Pickup",
|
|
841
872
|
"parameters": [
|
|
@@ -918,7 +949,9 @@
|
|
|
918
949
|
},
|
|
919
950
|
"/CancelPickup": {
|
|
920
951
|
"post": {
|
|
921
|
-
"tags": [
|
|
952
|
+
"tags": [
|
|
953
|
+
"Scheduled Pickups"
|
|
954
|
+
],
|
|
922
955
|
"operationId": "Cancel Adhoc Pickup",
|
|
923
956
|
"parameters": [
|
|
924
957
|
{
|
|
@@ -998,8 +1031,10 @@
|
|
|
998
1031
|
},
|
|
999
1032
|
"/GetRates": {
|
|
1000
1033
|
"post": {
|
|
1001
|
-
"tags": [
|
|
1002
|
-
|
|
1034
|
+
"tags": [
|
|
1035
|
+
"Rating"
|
|
1036
|
+
],
|
|
1037
|
+
"description": "This method calculates the shipping costs for a shipment, or multiple permutations of a shipment, to allow your customers to select the best rate. Most carrier apps should implement this method, unless you don't support rating shipments.",
|
|
1003
1038
|
"operationId": "Get Rates",
|
|
1004
1039
|
"parameters": [
|
|
1005
1040
|
{
|
|
@@ -1079,10 +1114,97 @@
|
|
|
1079
1114
|
}
|
|
1080
1115
|
}
|
|
1081
1116
|
},
|
|
1117
|
+
"/GetRelayPoints": {
|
|
1118
|
+
"post": {
|
|
1119
|
+
"tags": [
|
|
1120
|
+
"Relay Points"
|
|
1121
|
+
],
|
|
1122
|
+
"description": "This method gets carrier relay points based on search criteria.",
|
|
1123
|
+
"operationId": "Get Relay Points",
|
|
1124
|
+
"parameters": [
|
|
1125
|
+
{
|
|
1126
|
+
"name": "ShipStation-TransactionID",
|
|
1127
|
+
"in": "header",
|
|
1128
|
+
"description": "The transaction ID uniquely represents this request.",
|
|
1129
|
+
"schema": {
|
|
1130
|
+
"type": "string",
|
|
1131
|
+
"format": "uuid"
|
|
1132
|
+
}
|
|
1133
|
+
}
|
|
1134
|
+
],
|
|
1135
|
+
"requestBody": {
|
|
1136
|
+
"description": "An object containing search criteria for relay points.",
|
|
1137
|
+
"content": {
|
|
1138
|
+
"application/json": {
|
|
1139
|
+
"schema": {
|
|
1140
|
+
"$ref": "#/components/schemas/GetRelayPointsRequest"
|
|
1141
|
+
}
|
|
1142
|
+
}
|
|
1143
|
+
}
|
|
1144
|
+
},
|
|
1145
|
+
"responses": {
|
|
1146
|
+
"400": {
|
|
1147
|
+
"description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
|
|
1148
|
+
"content": {
|
|
1149
|
+
"application/json": {
|
|
1150
|
+
"schema": {
|
|
1151
|
+
"$ref": "#/components/schemas/BadRequestResponse"
|
|
1152
|
+
}
|
|
1153
|
+
}
|
|
1154
|
+
}
|
|
1155
|
+
},
|
|
1156
|
+
"401": {
|
|
1157
|
+
"description": "Use this to indicate an authentication or authorization error.",
|
|
1158
|
+
"content": {
|
|
1159
|
+
"application/json": {
|
|
1160
|
+
"schema": {
|
|
1161
|
+
"$ref": "#/components/schemas/UnauthorizedResponse"
|
|
1162
|
+
}
|
|
1163
|
+
}
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
"500": {
|
|
1167
|
+
"description": "An unexpected error occurred in the carrier app.",
|
|
1168
|
+
"content": {
|
|
1169
|
+
"application/json": {
|
|
1170
|
+
"schema": {
|
|
1171
|
+
"$ref": "#/components/schemas/InternalServerErrorResponse"
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
1174
|
+
}
|
|
1175
|
+
},
|
|
1176
|
+
"520": {
|
|
1177
|
+
"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.",
|
|
1178
|
+
"content": {
|
|
1179
|
+
"application/json": {
|
|
1180
|
+
"schema": {
|
|
1181
|
+
"$ref": "#/components/schemas/ExternalServerErrorResponse"
|
|
1182
|
+
}
|
|
1183
|
+
}
|
|
1184
|
+
}
|
|
1185
|
+
},
|
|
1186
|
+
"404": {
|
|
1187
|
+
"description": "Use this when the behavior is not supported or the behavior is not available for the user."
|
|
1188
|
+
},
|
|
1189
|
+
"200": {
|
|
1190
|
+
"description": "This object model represents the response from a successful get relay points request.",
|
|
1191
|
+
"content": {
|
|
1192
|
+
"application/json": {
|
|
1193
|
+
"schema": {
|
|
1194
|
+
"$ref": "#/components/schemas/GetRelayPointsResponse"
|
|
1195
|
+
}
|
|
1196
|
+
}
|
|
1197
|
+
}
|
|
1198
|
+
}
|
|
1199
|
+
}
|
|
1200
|
+
}
|
|
1201
|
+
},
|
|
1082
1202
|
"/Track": {
|
|
1083
1203
|
"post": {
|
|
1084
|
-
"tags": [
|
|
1085
|
-
|
|
1204
|
+
"tags": [
|
|
1205
|
+
"Tracking"
|
|
1206
|
+
],
|
|
1207
|
+
"description": "This method returns tracking information for a shipment, including each of the tracking events that have occurred for the shipment. Most carrier applications should implement this method, unless you don't support tracking shipments.",
|
|
1086
1208
|
"operationId": "Track a Shipment",
|
|
1087
1209
|
"parameters": [
|
|
1088
1210
|
{
|
|
@@ -1200,7 +1322,10 @@
|
|
|
1200
1322
|
"width": 10.0,
|
|
1201
1323
|
"height": 10.0
|
|
1202
1324
|
},
|
|
1203
|
-
"service": {
|
|
1325
|
+
"service": {
|
|
1326
|
+
"code": "03",
|
|
1327
|
+
"name": "UPS® Ground"
|
|
1328
|
+
},
|
|
1204
1329
|
"packaging": "package",
|
|
1205
1330
|
"package_count": 1,
|
|
1206
1331
|
"events": [
|
|
@@ -1213,7 +1338,10 @@
|
|
|
1213
1338
|
"state": "TX",
|
|
1214
1339
|
"postal_code": "78756",
|
|
1215
1340
|
"country": "US",
|
|
1216
|
-
"geo": {
|
|
1341
|
+
"geo": {
|
|
1342
|
+
"lat": 30.31,
|
|
1343
|
+
"long": -97.74
|
|
1344
|
+
},
|
|
1217
1345
|
"status_code": "AC"
|
|
1218
1346
|
},
|
|
1219
1347
|
{
|
|
@@ -1225,7 +1353,10 @@
|
|
|
1225
1353
|
"state": "TX",
|
|
1226
1354
|
"postal_code": "78756",
|
|
1227
1355
|
"country": "US",
|
|
1228
|
-
"geo": {
|
|
1356
|
+
"geo": {
|
|
1357
|
+
"lat": 30.2,
|
|
1358
|
+
"long": -97.66
|
|
1359
|
+
},
|
|
1229
1360
|
"status_code": "IT"
|
|
1230
1361
|
},
|
|
1231
1362
|
{
|
|
@@ -1237,7 +1368,10 @@
|
|
|
1237
1368
|
"state": "CA",
|
|
1238
1369
|
"postal_code": "90045",
|
|
1239
1370
|
"country": "US",
|
|
1240
|
-
"geo": {
|
|
1371
|
+
"geo": {
|
|
1372
|
+
"lat": 33.95,
|
|
1373
|
+
"long": -118.38
|
|
1374
|
+
},
|
|
1241
1375
|
"status_code": "IT"
|
|
1242
1376
|
},
|
|
1243
1377
|
{
|
|
@@ -1249,7 +1383,10 @@
|
|
|
1249
1383
|
"state": "CA",
|
|
1250
1384
|
"postal_code": "90045",
|
|
1251
1385
|
"country": "US",
|
|
1252
|
-
"geo": {
|
|
1386
|
+
"geo": {
|
|
1387
|
+
"lat": 33.95,
|
|
1388
|
+
"long": -118.38
|
|
1389
|
+
},
|
|
1253
1390
|
"status_code": "IT"
|
|
1254
1391
|
},
|
|
1255
1392
|
{
|
|
@@ -1261,7 +1398,10 @@
|
|
|
1261
1398
|
"state": "CA",
|
|
1262
1399
|
"postal_code": "90245",
|
|
1263
1400
|
"country": "US",
|
|
1264
|
-
"geo": {
|
|
1401
|
+
"geo": {
|
|
1402
|
+
"lat": 33.95,
|
|
1403
|
+
"long": -118.38
|
|
1404
|
+
},
|
|
1265
1405
|
"status_code": "AT"
|
|
1266
1406
|
},
|
|
1267
1407
|
{
|
|
@@ -1273,7 +1413,10 @@
|
|
|
1273
1413
|
"state": "CA",
|
|
1274
1414
|
"postal_code": "90045",
|
|
1275
1415
|
"country": "US",
|
|
1276
|
-
"geo": {
|
|
1416
|
+
"geo": {
|
|
1417
|
+
"lat": 33.95,
|
|
1418
|
+
"long": -118.38
|
|
1419
|
+
},
|
|
1277
1420
|
"status_code": "IT"
|
|
1278
1421
|
},
|
|
1279
1422
|
{
|
|
@@ -1285,7 +1428,10 @@
|
|
|
1285
1428
|
"state": "CA",
|
|
1286
1429
|
"postal_code": "90245",
|
|
1287
1430
|
"country": "US",
|
|
1288
|
-
"geo": {
|
|
1431
|
+
"geo": {
|
|
1432
|
+
"lat": 33.95,
|
|
1433
|
+
"long": -118.38
|
|
1434
|
+
},
|
|
1289
1435
|
"status_code": "DE"
|
|
1290
1436
|
}
|
|
1291
1437
|
],
|
|
@@ -1324,7 +1470,10 @@
|
|
|
1324
1470
|
"width": 10.0,
|
|
1325
1471
|
"height": 10.0
|
|
1326
1472
|
},
|
|
1327
|
-
"service": {
|
|
1473
|
+
"service": {
|
|
1474
|
+
"code": "03",
|
|
1475
|
+
"name": "UPS® Ground"
|
|
1476
|
+
},
|
|
1328
1477
|
"packaging": "package",
|
|
1329
1478
|
"package_count": 1,
|
|
1330
1479
|
"events": [
|
|
@@ -1337,7 +1486,10 @@
|
|
|
1337
1486
|
"state": "TX",
|
|
1338
1487
|
"postal_code": "78756",
|
|
1339
1488
|
"country": "US",
|
|
1340
|
-
"geo": {
|
|
1489
|
+
"geo": {
|
|
1490
|
+
"lat": 30.2,
|
|
1491
|
+
"long": -97.66
|
|
1492
|
+
},
|
|
1341
1493
|
"status_code": "IT"
|
|
1342
1494
|
},
|
|
1343
1495
|
{
|
|
@@ -1349,7 +1501,10 @@
|
|
|
1349
1501
|
"state": "CA",
|
|
1350
1502
|
"postal_code": "90245",
|
|
1351
1503
|
"country": "US",
|
|
1352
|
-
"geo": {
|
|
1504
|
+
"geo": {
|
|
1505
|
+
"lat": 33.95,
|
|
1506
|
+
"long": -118.38
|
|
1507
|
+
},
|
|
1353
1508
|
"status_code": "EX"
|
|
1354
1509
|
}
|
|
1355
1510
|
],
|
|
@@ -1449,7 +1604,13 @@
|
|
|
1449
1604
|
"additionalProperties": false
|
|
1450
1605
|
},
|
|
1451
1606
|
"AddressResidentialIndicator": {
|
|
1452
|
-
"enum": [
|
|
1607
|
+
"enum": [
|
|
1608
|
+
"unknown",
|
|
1609
|
+
"yes",
|
|
1610
|
+
"no",
|
|
1611
|
+
"commercial",
|
|
1612
|
+
"residential"
|
|
1613
|
+
],
|
|
1453
1614
|
"type": "string"
|
|
1454
1615
|
},
|
|
1455
1616
|
"AdvancedOptions": {
|
|
@@ -1477,7 +1638,7 @@
|
|
|
1477
1638
|
"type": "string",
|
|
1478
1639
|
"description": "Decimal currency value, as a string."
|
|
1479
1640
|
},
|
|
1480
|
-
"
|
|
1641
|
+
"currency": {
|
|
1481
1642
|
"type": "string",
|
|
1482
1643
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
1483
1644
|
}
|
|
@@ -1599,7 +1760,7 @@
|
|
|
1599
1760
|
"type": "string",
|
|
1600
1761
|
"description": "Decimal currency value, as a string."
|
|
1601
1762
|
},
|
|
1602
|
-
"
|
|
1763
|
+
"currency": {
|
|
1603
1764
|
"type": "string",
|
|
1604
1765
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
1605
1766
|
}
|
|
@@ -1628,10 +1789,14 @@
|
|
|
1628
1789
|
}
|
|
1629
1790
|
},
|
|
1630
1791
|
"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 other than the shipper (the shipper is considered the default party responsible). CarrierApi.Common.Request.CarrierApi.Common.Models.BillTo extends CarrierApi.Common.Models.Addresses.AddressBase since address fields are often required when associating billing to another account.
|
|
1792
|
+
"description": "Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party other than the shipper (the shipper is considered the default party responsible). CarrierApi.Common.Request.CarrierApi.Common.Models.BillTo extends CarrierApi.Common.Models.Addresses.AddressBase since address fields are often required when associating billing to another account. Additionally, this allows for a contact to be specified, if necessary."
|
|
1632
1793
|
},
|
|
1633
1794
|
"BillToParty": {
|
|
1634
|
-
"enum": [
|
|
1795
|
+
"enum": [
|
|
1796
|
+
"shipper",
|
|
1797
|
+
"recipient",
|
|
1798
|
+
"third_party_account"
|
|
1799
|
+
],
|
|
1635
1800
|
"type": "string",
|
|
1636
1801
|
"description": "The type of party responsible for a given category of charges associated with a shipment, such as shipping charges or import duties."
|
|
1637
1802
|
},
|
|
@@ -1860,6 +2025,9 @@
|
|
|
1860
2025
|
"pickup_location": {
|
|
1861
2026
|
"$ref": "#/components/schemas/PudoLocation"
|
|
1862
2027
|
},
|
|
2028
|
+
"relay_points": {
|
|
2029
|
+
"$ref": "#/components/schemas/RelayPointDetails"
|
|
2030
|
+
},
|
|
1863
2031
|
"ship_from_display": {
|
|
1864
2032
|
"$ref": "#/components/schemas/ShipFromDisplay"
|
|
1865
2033
|
},
|
|
@@ -1978,35 +2146,14 @@
|
|
|
1978
2146
|
},
|
|
1979
2147
|
"delivery_window": {
|
|
1980
2148
|
"$ref": "#/components/schemas/TimeWindow"
|
|
2149
|
+
},
|
|
2150
|
+
"relay_points": {
|
|
2151
|
+
"$ref": "#/components/schemas/RelayPointDetails"
|
|
1981
2152
|
}
|
|
1982
2153
|
},
|
|
1983
2154
|
"additionalProperties": false,
|
|
1984
2155
|
"description": "This model represents the response from a successful create label request."
|
|
1985
2156
|
},
|
|
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
2157
|
"CreateManifestRequest": {
|
|
2011
2158
|
"type": "object",
|
|
2012
2159
|
"allOf": [
|
|
@@ -2021,7 +2168,7 @@
|
|
|
2021
2168
|
"included_labels": {
|
|
2022
2169
|
"type": "array",
|
|
2023
2170
|
"items": {
|
|
2024
|
-
"$ref": "#/components/schemas/
|
|
2171
|
+
"$ref": "#/components/schemas/ManifestRequestShipment"
|
|
2025
2172
|
},
|
|
2026
2173
|
"description": "The shipments to include in the manifest. There should be at least one shipment included in a manifest.",
|
|
2027
2174
|
"nullable": true
|
|
@@ -2029,7 +2176,7 @@
|
|
|
2029
2176
|
"excluded_labels": {
|
|
2030
2177
|
"type": "array",
|
|
2031
2178
|
"items": {
|
|
2032
|
-
"$ref": "#/components/schemas/
|
|
2179
|
+
"$ref": "#/components/schemas/ManifestRequestShipment"
|
|
2033
2180
|
},
|
|
2034
2181
|
"description": "The shipments to exclude from the manifest.",
|
|
2035
2182
|
"nullable": true
|
|
@@ -2071,6 +2218,41 @@
|
|
|
2071
2218
|
},
|
|
2072
2219
|
"description": "The manifests created from this request. It should contain either a href or data, but not both.",
|
|
2073
2220
|
"nullable": true
|
|
2221
|
+
},
|
|
2222
|
+
"errors": {
|
|
2223
|
+
"type": "array",
|
|
2224
|
+
"items": {
|
|
2225
|
+
"$ref": "#/components/schemas/ManifestError"
|
|
2226
|
+
},
|
|
2227
|
+
"description": "Errored shipments if some but not all shipments were successfully manifested",
|
|
2228
|
+
"nullable": true
|
|
2229
|
+
},
|
|
2230
|
+
"manifest_status": {
|
|
2231
|
+
"$ref": "#/components/schemas/ManifestStatus"
|
|
2232
|
+
},
|
|
2233
|
+
"manifest_request_id": {
|
|
2234
|
+
"type": "integer",
|
|
2235
|
+
"description": "Manifest request identifier.",
|
|
2236
|
+
"format": "int64",
|
|
2237
|
+
"nullable": true
|
|
2238
|
+
},
|
|
2239
|
+
"total_shipments": {
|
|
2240
|
+
"type": "integer",
|
|
2241
|
+
"description": "Total number of shipments requested for manifesting.",
|
|
2242
|
+
"format": "int32",
|
|
2243
|
+
"nullable": true
|
|
2244
|
+
},
|
|
2245
|
+
"total_invalid": {
|
|
2246
|
+
"type": "integer",
|
|
2247
|
+
"description": "Total number of shipments that failed to manifest.",
|
|
2248
|
+
"format": "int32",
|
|
2249
|
+
"nullable": true
|
|
2250
|
+
},
|
|
2251
|
+
"manifest_identifiers": {
|
|
2252
|
+
"type": "object",
|
|
2253
|
+
"additionalProperties": {},
|
|
2254
|
+
"description": "Carrier information needed to get created manifests. Only needed if carrier requires two calls to create and get manifests.",
|
|
2255
|
+
"nullable": true
|
|
2074
2256
|
}
|
|
2075
2257
|
},
|
|
2076
2258
|
"additionalProperties": false,
|
|
@@ -2089,6 +2271,9 @@
|
|
|
2089
2271
|
},
|
|
2090
2272
|
"create_label_request": {
|
|
2091
2273
|
"$ref": "#/components/schemas/CreateLabelRequest"
|
|
2274
|
+
},
|
|
2275
|
+
"advanced_options": {
|
|
2276
|
+
"$ref": "#/components/schemas/AdvancedOptions"
|
|
2092
2277
|
}
|
|
2093
2278
|
},
|
|
2094
2279
|
"additionalProperties": false,
|
|
@@ -2106,6 +2291,14 @@
|
|
|
2106
2291
|
"type": "string",
|
|
2107
2292
|
"description": "The id of the successfully created notification.",
|
|
2108
2293
|
"nullable": true
|
|
2294
|
+
},
|
|
2295
|
+
"billing_line_items": {
|
|
2296
|
+
"type": "array",
|
|
2297
|
+
"items": {
|
|
2298
|
+
"$ref": "#/components/schemas/BillingLineItem"
|
|
2299
|
+
},
|
|
2300
|
+
"description": "Individual Billing Line items for the label.",
|
|
2301
|
+
"nullable": true
|
|
2109
2302
|
}
|
|
2110
2303
|
},
|
|
2111
2304
|
"additionalProperties": false,
|
|
@@ -2149,7 +2342,7 @@
|
|
|
2149
2342
|
"type": "string",
|
|
2150
2343
|
"description": "Decimal currency value, as a string."
|
|
2151
2344
|
},
|
|
2152
|
-
"
|
|
2345
|
+
"currency": {
|
|
2153
2346
|
"type": "string",
|
|
2154
2347
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2155
2348
|
}
|
|
@@ -2163,7 +2356,7 @@
|
|
|
2163
2356
|
"type": "string",
|
|
2164
2357
|
"description": "Decimal currency value, as a string."
|
|
2165
2358
|
},
|
|
2166
|
-
"
|
|
2359
|
+
"currency": {
|
|
2167
2360
|
"type": "string",
|
|
2168
2361
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2169
2362
|
}
|
|
@@ -2206,7 +2399,7 @@
|
|
|
2206
2399
|
"type": "string",
|
|
2207
2400
|
"description": "Decimal currency value, as a string."
|
|
2208
2401
|
},
|
|
2209
|
-
"
|
|
2402
|
+
"currency": {
|
|
2210
2403
|
"type": "string",
|
|
2211
2404
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2212
2405
|
}
|
|
@@ -2242,7 +2435,10 @@
|
|
|
2242
2435
|
"description": "This model represents the customs declaration for a single item."
|
|
2243
2436
|
},
|
|
2244
2437
|
"CustomsNonDelivery": {
|
|
2245
|
-
"enum": [
|
|
2438
|
+
"enum": [
|
|
2439
|
+
"return_to_sender",
|
|
2440
|
+
"treat_as_abandoned"
|
|
2441
|
+
],
|
|
2246
2442
|
"type": "string",
|
|
2247
2443
|
"description": "What to do if the shipment is undeliverable."
|
|
2248
2444
|
},
|
|
@@ -2325,7 +2521,10 @@
|
|
|
2325
2521
|
"description": "This model represents the measurements for dimensions."
|
|
2326
2522
|
},
|
|
2327
2523
|
"DimensionUnit": {
|
|
2328
|
-
"enum": [
|
|
2524
|
+
"enum": [
|
|
2525
|
+
"inches",
|
|
2526
|
+
"centimeters"
|
|
2527
|
+
],
|
|
2329
2528
|
"type": "string",
|
|
2330
2529
|
"description": "This model represents the supported units for dimensions."
|
|
2331
2530
|
},
|
|
@@ -2353,7 +2552,11 @@
|
|
|
2353
2552
|
"description": "Container for a document."
|
|
2354
2553
|
},
|
|
2355
2554
|
"DocumentFormat": {
|
|
2356
|
-
"enum": [
|
|
2555
|
+
"enum": [
|
|
2556
|
+
"PDF",
|
|
2557
|
+
"ZPL",
|
|
2558
|
+
"PNG"
|
|
2559
|
+
],
|
|
2357
2560
|
"type": "string"
|
|
2358
2561
|
},
|
|
2359
2562
|
"DocumentType": {
|
|
@@ -2462,6 +2665,34 @@
|
|
|
2462
2665
|
"additionalProperties": false,
|
|
2463
2666
|
"description": "This contains information about the fulfillment plan for a set of items."
|
|
2464
2667
|
},
|
|
2668
|
+
"GetManifestRequest": {
|
|
2669
|
+
"type": "object",
|
|
2670
|
+
"allOf": [
|
|
2671
|
+
{
|
|
2672
|
+
"$ref": "#/components/schemas/BaseRequest"
|
|
2673
|
+
}
|
|
2674
|
+
],
|
|
2675
|
+
"properties": {
|
|
2676
|
+
"manifest_request_id": {
|
|
2677
|
+
"type": "integer",
|
|
2678
|
+
"description": "Manifest request identifier.",
|
|
2679
|
+
"format": "int64",
|
|
2680
|
+
"nullable": true
|
|
2681
|
+
},
|
|
2682
|
+
"return_immediately": {
|
|
2683
|
+
"type": "boolean",
|
|
2684
|
+
"description": "Return immediately after checking status. Full manifest creation can take up to 2 minutes. Set to false to allow additional checks before timeout."
|
|
2685
|
+
},
|
|
2686
|
+
"manifest_identifiers": {
|
|
2687
|
+
"type": "object",
|
|
2688
|
+
"additionalProperties": {},
|
|
2689
|
+
"description": "Carrier specific data needed to retrieve Manifest results",
|
|
2690
|
+
"nullable": true
|
|
2691
|
+
}
|
|
2692
|
+
},
|
|
2693
|
+
"additionalProperties": false,
|
|
2694
|
+
"description": "This model represents the request payload needed to get a manifest that has already been created."
|
|
2695
|
+
},
|
|
2465
2696
|
"GetRatesRequest": {
|
|
2466
2697
|
"type": "object",
|
|
2467
2698
|
"allOf": [
|
|
@@ -2556,6 +2787,47 @@
|
|
|
2556
2787
|
"additionalProperties": false,
|
|
2557
2788
|
"description": "This model represents the response for a get rates request."
|
|
2558
2789
|
},
|
|
2790
|
+
"GetRelayPointsRequest": {
|
|
2791
|
+
"type": "object",
|
|
2792
|
+
"allOf": [
|
|
2793
|
+
{
|
|
2794
|
+
"$ref": "#/components/schemas/BaseRequest"
|
|
2795
|
+
}
|
|
2796
|
+
],
|
|
2797
|
+
"properties": {
|
|
2798
|
+
"service_code": {
|
|
2799
|
+
"type": "string",
|
|
2800
|
+
"description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine.",
|
|
2801
|
+
"nullable": true
|
|
2802
|
+
},
|
|
2803
|
+
"postal_code": {
|
|
2804
|
+
"type": "string",
|
|
2805
|
+
"description": "The postal code to use when searching for available relay points.",
|
|
2806
|
+
"nullable": true
|
|
2807
|
+
},
|
|
2808
|
+
"country_code": {
|
|
2809
|
+
"type": "string",
|
|
2810
|
+
"description": "The two character country code to use when searching for available relay points. The codes are specified by ISO 3166-1 alpha-2.",
|
|
2811
|
+
"nullable": true
|
|
2812
|
+
}
|
|
2813
|
+
},
|
|
2814
|
+
"additionalProperties": false,
|
|
2815
|
+
"description": "This model represents the payload sent to get relay points based on the provided search criteria."
|
|
2816
|
+
},
|
|
2817
|
+
"GetRelayPointsResponse": {
|
|
2818
|
+
"type": "object",
|
|
2819
|
+
"properties": {
|
|
2820
|
+
"relay_points": {
|
|
2821
|
+
"type": "array",
|
|
2822
|
+
"items": {
|
|
2823
|
+
"$ref": "#/components/schemas/RelayPoint"
|
|
2824
|
+
},
|
|
2825
|
+
"nullable": true
|
|
2826
|
+
}
|
|
2827
|
+
},
|
|
2828
|
+
"additionalProperties": false,
|
|
2829
|
+
"description": "Basic structure for a response to get relay points"
|
|
2830
|
+
},
|
|
2559
2831
|
"Identifier": {
|
|
2560
2832
|
"type": "object",
|
|
2561
2833
|
"properties": {
|
|
@@ -2574,11 +2846,18 @@
|
|
|
2574
2846
|
"description": "A key value pair, allowing custom properties to be stored."
|
|
2575
2847
|
},
|
|
2576
2848
|
"InboundDataContentTypes": {
|
|
2577
|
-
"enum": [
|
|
2849
|
+
"enum": [
|
|
2850
|
+
"tracking"
|
|
2851
|
+
],
|
|
2578
2852
|
"type": "string"
|
|
2579
2853
|
},
|
|
2580
2854
|
"InsuranceProviders": {
|
|
2581
|
-
"enum": [
|
|
2855
|
+
"enum": [
|
|
2856
|
+
"None",
|
|
2857
|
+
"ShipStation",
|
|
2858
|
+
"Carrier",
|
|
2859
|
+
"External"
|
|
2860
|
+
],
|
|
2582
2861
|
"type": "string"
|
|
2583
2862
|
},
|
|
2584
2863
|
"InternalServerErrorResponse": {
|
|
@@ -2602,7 +2881,10 @@
|
|
|
2602
2881
|
"description": "This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response."
|
|
2603
2882
|
},
|
|
2604
2883
|
"LabelLayouts": {
|
|
2605
|
-
"enum": [
|
|
2884
|
+
"enum": [
|
|
2885
|
+
"4x6",
|
|
2886
|
+
"letter"
|
|
2887
|
+
],
|
|
2606
2888
|
"type": "string"
|
|
2607
2889
|
},
|
|
2608
2890
|
"LabelMessage": {
|
|
@@ -2680,11 +2962,65 @@
|
|
|
2680
2962
|
},
|
|
2681
2963
|
"document_download": {
|
|
2682
2964
|
"$ref": "#/components/schemas/ResourceDownload"
|
|
2965
|
+
},
|
|
2966
|
+
"manifest_request_shipment_ids": {
|
|
2967
|
+
"type": "array",
|
|
2968
|
+
"items": {
|
|
2969
|
+
"type": "string",
|
|
2970
|
+
"format": "uuid"
|
|
2971
|
+
},
|
|
2972
|
+
"description": "The manifest request shipment id's associated with this manifest document",
|
|
2973
|
+
"nullable": true
|
|
2683
2974
|
}
|
|
2684
2975
|
},
|
|
2685
2976
|
"additionalProperties": false,
|
|
2686
2977
|
"description": "This model represents a single manifest created with a shipping provider."
|
|
2687
2978
|
},
|
|
2979
|
+
"ManifestError": {
|
|
2980
|
+
"type": "object",
|
|
2981
|
+
"properties": {
|
|
2982
|
+
"manifest_request_shipment_ids": {
|
|
2983
|
+
"type": "array",
|
|
2984
|
+
"items": {
|
|
2985
|
+
"type": "string",
|
|
2986
|
+
"format": "uuid"
|
|
2987
|
+
},
|
|
2988
|
+
"description": "Manifest shipment request ID's associated with this error message",
|
|
2989
|
+
"nullable": true
|
|
2990
|
+
},
|
|
2991
|
+
"message": {
|
|
2992
|
+
"type": "string",
|
|
2993
|
+
"description": "Error message",
|
|
2994
|
+
"nullable": true
|
|
2995
|
+
}
|
|
2996
|
+
},
|
|
2997
|
+
"additionalProperties": false
|
|
2998
|
+
},
|
|
2999
|
+
"ManifestRequestShipment": {
|
|
3000
|
+
"type": "object",
|
|
3001
|
+
"allOf": [
|
|
3002
|
+
{
|
|
3003
|
+
"$ref": "#/components/schemas/ShippedShipment"
|
|
3004
|
+
}
|
|
3005
|
+
],
|
|
3006
|
+
"properties": {
|
|
3007
|
+
"manifest_request_shipment_id": {
|
|
3008
|
+
"type": "string",
|
|
3009
|
+
"description": "Uniquely identifies this request to manifest a shipment. Used to identify which shipments could not be manifested.",
|
|
3010
|
+
"format": "uuid"
|
|
3011
|
+
}
|
|
3012
|
+
},
|
|
3013
|
+
"additionalProperties": false
|
|
3014
|
+
},
|
|
3015
|
+
"ManifestStatus": {
|
|
3016
|
+
"enum": [
|
|
3017
|
+
"unknown",
|
|
3018
|
+
"in_progress",
|
|
3019
|
+
"completed",
|
|
3020
|
+
"failed"
|
|
3021
|
+
],
|
|
3022
|
+
"type": "string"
|
|
3023
|
+
},
|
|
2688
3024
|
"NormalizeTrackingDataRequest": {
|
|
2689
3025
|
"type": "object",
|
|
2690
3026
|
"allOf": [
|
|
@@ -2736,6 +3072,41 @@
|
|
|
2736
3072
|
"additionalProperties": false,
|
|
2737
3073
|
"description": "This model represents the successful response from a normalize tracking data request."
|
|
2738
3074
|
},
|
|
3075
|
+
"OpeningTimes": {
|
|
3076
|
+
"type": "object",
|
|
3077
|
+
"properties": {
|
|
3078
|
+
"monday": {
|
|
3079
|
+
"type": "string",
|
|
3080
|
+
"nullable": true
|
|
3081
|
+
},
|
|
3082
|
+
"tuesday": {
|
|
3083
|
+
"type": "string",
|
|
3084
|
+
"nullable": true
|
|
3085
|
+
},
|
|
3086
|
+
"wednesday": {
|
|
3087
|
+
"type": "string",
|
|
3088
|
+
"nullable": true
|
|
3089
|
+
},
|
|
3090
|
+
"thursday": {
|
|
3091
|
+
"type": "string",
|
|
3092
|
+
"nullable": true
|
|
3093
|
+
},
|
|
3094
|
+
"friday": {
|
|
3095
|
+
"type": "string",
|
|
3096
|
+
"nullable": true
|
|
3097
|
+
},
|
|
3098
|
+
"saturday": {
|
|
3099
|
+
"type": "string",
|
|
3100
|
+
"nullable": true
|
|
3101
|
+
},
|
|
3102
|
+
"sunday": {
|
|
3103
|
+
"type": "string",
|
|
3104
|
+
"nullable": true
|
|
3105
|
+
}
|
|
3106
|
+
},
|
|
3107
|
+
"additionalProperties": false,
|
|
3108
|
+
"description": "The times each day that the relay point is open, for example: \"11:00-13:00, 14:30-19:30\""
|
|
3109
|
+
},
|
|
2739
3110
|
"Package": {
|
|
2740
3111
|
"type": "object",
|
|
2741
3112
|
"properties": {
|
|
@@ -2756,7 +3127,7 @@
|
|
|
2756
3127
|
"type": "string",
|
|
2757
3128
|
"description": "Decimal currency value, as a string."
|
|
2758
3129
|
},
|
|
2759
|
-
"
|
|
3130
|
+
"currency": {
|
|
2760
3131
|
"type": "string",
|
|
2761
3132
|
"description": "Alpha-3 currency code complying with ISO 4217."
|
|
2762
3133
|
}
|
|
@@ -3053,6 +3424,86 @@
|
|
|
3053
3424
|
"additionalProperties": false,
|
|
3054
3425
|
"description": "This model represents the successful response for a registration request."
|
|
3055
3426
|
},
|
|
3427
|
+
"RelayPoint": {
|
|
3428
|
+
"type": "object",
|
|
3429
|
+
"allOf": [
|
|
3430
|
+
{
|
|
3431
|
+
"$ref": "#/components/schemas/RelayPointAddress"
|
|
3432
|
+
}
|
|
3433
|
+
],
|
|
3434
|
+
"properties": {
|
|
3435
|
+
"phone": {
|
|
3436
|
+
"type": "string",
|
|
3437
|
+
"nullable": true
|
|
3438
|
+
},
|
|
3439
|
+
"longitude": {
|
|
3440
|
+
"type": "integer",
|
|
3441
|
+
"format": "int32",
|
|
3442
|
+
"nullable": true
|
|
3443
|
+
},
|
|
3444
|
+
"latitude": {
|
|
3445
|
+
"type": "integer",
|
|
3446
|
+
"format": "int32",
|
|
3447
|
+
"nullable": true
|
|
3448
|
+
},
|
|
3449
|
+
"opening_times": {
|
|
3450
|
+
"$ref": "#/components/schemas/OpeningTimes"
|
|
3451
|
+
}
|
|
3452
|
+
},
|
|
3453
|
+
"additionalProperties": false,
|
|
3454
|
+
"description": "Basic structure for a relay point"
|
|
3455
|
+
},
|
|
3456
|
+
"RelayPointAddress": {
|
|
3457
|
+
"type": "object",
|
|
3458
|
+
"properties": {
|
|
3459
|
+
"relay_point_id": {
|
|
3460
|
+
"type": "string",
|
|
3461
|
+
"nullable": true
|
|
3462
|
+
},
|
|
3463
|
+
"company_name": {
|
|
3464
|
+
"type": "string",
|
|
3465
|
+
"nullable": true
|
|
3466
|
+
},
|
|
3467
|
+
"address_lines": {
|
|
3468
|
+
"type": "array",
|
|
3469
|
+
"items": {
|
|
3470
|
+
"type": "string"
|
|
3471
|
+
},
|
|
3472
|
+
"nullable": true
|
|
3473
|
+
},
|
|
3474
|
+
"city_locality": {
|
|
3475
|
+
"type": "string",
|
|
3476
|
+
"nullable": true
|
|
3477
|
+
},
|
|
3478
|
+
"state_province": {
|
|
3479
|
+
"type": "string",
|
|
3480
|
+
"nullable": true
|
|
3481
|
+
},
|
|
3482
|
+
"postal_code": {
|
|
3483
|
+
"type": "string",
|
|
3484
|
+
"nullable": true
|
|
3485
|
+
},
|
|
3486
|
+
"country_code": {
|
|
3487
|
+
"type": "string",
|
|
3488
|
+
"nullable": true
|
|
3489
|
+
}
|
|
3490
|
+
},
|
|
3491
|
+
"additionalProperties": false,
|
|
3492
|
+
"description": "The address information corresponding to a specific relay point"
|
|
3493
|
+
},
|
|
3494
|
+
"RelayPointDetails": {
|
|
3495
|
+
"type": "object",
|
|
3496
|
+
"properties": {
|
|
3497
|
+
"ship_to": {
|
|
3498
|
+
"$ref": "#/components/schemas/RelayPointAddress"
|
|
3499
|
+
},
|
|
3500
|
+
"ship_from": {
|
|
3501
|
+
"$ref": "#/components/schemas/RelayPointAddress"
|
|
3502
|
+
}
|
|
3503
|
+
},
|
|
3504
|
+
"additionalProperties": false,
|
|
3505
|
+
"description": "Details of the relay points used for the shipment"
|
|
3506
|
+
},
|
|
3056
3507
|
"ResourceDownload": {
|
|
3057
3508
|
"type": "object",
|
|
3058
3509
|
"properties": {
|
|
@@ -3326,12 +3777,29 @@
|
|
|
3326
3777
|
"description": "A list of standard error identifiers for errors the module can return"
|
|
3327
3778
|
},
|
|
3328
3779
|
"StandardizedStatusCodes": {
|
|
3329
|
-
"enum": [
|
|
3780
|
+
"enum": [
|
|
3781
|
+
"UN",
|
|
3782
|
+
"AC",
|
|
3783
|
+
"IT",
|
|
3784
|
+
"DE",
|
|
3785
|
+
"EX",
|
|
3786
|
+
"AT",
|
|
3787
|
+
"NY"
|
|
3788
|
+
],
|
|
3330
3789
|
"type": "string",
|
|
3331
3790
|
"description": "This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System"
|
|
3332
3791
|
},
|
|
3333
3792
|
"TaxIdentificationType": {
|
|
3334
|
-
"enum": [
|
|
3793
|
+
"enum": [
|
|
3794
|
+
"tin",
|
|
3795
|
+
"ein",
|
|
3796
|
+
"ssn",
|
|
3797
|
+
"vat",
|
|
3798
|
+
"eori",
|
|
3799
|
+
"ioss",
|
|
3800
|
+
"pan",
|
|
3801
|
+
"voec"
|
|
3802
|
+
],
|
|
3335
3803
|
"type": "string",
|
|
3336
3804
|
"description": "Specifies the supported tax identification types."
|
|
3337
3805
|
},
|
|
@@ -3631,7 +4099,10 @@
|
|
|
3631
4099
|
"description": "This model represents a response that the request was unauthorized to perform some action."
|
|
3632
4100
|
},
|
|
3633
4101
|
"UpdateMethods": {
|
|
3634
|
-
"enum": [
|
|
4102
|
+
"enum": [
|
|
4103
|
+
"append",
|
|
4104
|
+
"replace"
|
|
4105
|
+
],
|
|
3635
4106
|
"type": "string"
|
|
3636
4107
|
},
|
|
3637
4108
|
"ValidateInboundDataRequest": {
|
|
@@ -3801,7 +4272,12 @@
|
|
|
3801
4272
|
"description": "This model represents the weight of a package in its original unit, ounces, and grams."
|
|
3802
4273
|
},
|
|
3803
4274
|
"WeightUnit": {
|
|
3804
|
-
"enum": [
|
|
4275
|
+
"enum": [
|
|
4276
|
+
"grams",
|
|
4277
|
+
"ounces",
|
|
4278
|
+
"kilograms",
|
|
4279
|
+
"pounds"
|
|
4280
|
+
],
|
|
3805
4281
|
"type": "string",
|
|
3806
4282
|
"description": "This model describes the possible units of weight."
|
|
3807
4283
|
}
|
|
@@ -3816,6 +4292,10 @@
|
|
|
3816
4292
|
"name": "Rating",
|
|
3817
4293
|
"description": ""
|
|
3818
4294
|
},
|
|
4295
|
+
{
|
|
4296
|
+
"name": "Relay Points",
|
|
4297
|
+
"description": "Relay points are the ship from/to locations used with Pickup/Drop Off (PUDO) shipments"
|
|
4298
|
+
},
|
|
3819
4299
|
{
|
|
3820
4300
|
"name": "Labels",
|
|
3821
4301
|
"description": ""
|
|
@@ -3841,4 +4321,4 @@
|
|
|
3841
4321
|
"description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
|
|
3842
4322
|
}
|
|
3843
4323
|
]
|
|
3844
|
-
}
|
|
4324
|
+
}
|