@shipengine/connect-carrier-api 2.11.4 → 2.11.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/lib/app/metadata/carrier.js +2 -0
  2. package/lib/app/metadata/carrier.js.map +1 -1
  3. package/lib/models/taxes/tax-identifier-type.d.ts +9 -1
  4. package/lib/models/taxes/tax-identifier-type.js +8 -0
  5. package/lib/models/taxes/tax-identifier-type.js.map +1 -1
  6. package/package.json +1 -1
  7. package/spec.json +349 -408
  8. package/src/app/metadata/carrier.ts +5 -1
  9. package/src/models/taxes/tax-identifier-type.ts +8 -0
  10. package/tsconfig.tsbuildinfo +1 -1
package/spec.json CHANGED
@@ -3,12 +3,14 @@
3
3
  "info": {
4
4
  "title": "Shipping API",
5
5
  "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
6
- "version": "1.16.4"
6
+ "version": "1.16.13"
7
7
  },
8
8
  "paths": {
9
9
  "/Register": {
10
10
  "post": {
11
- "tags": ["Account Setup"],
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\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
  "requestBody": {
@@ -18,19 +20,7 @@
18
20
  "schema": {
19
21
  "$ref": "#/components/schemas/ExampleRegisterRequest"
20
22
  },
21
- "example": {
22
- "registration_info": {
23
- "username": "auctane-next-day",
24
- "password": "password!",
25
- "meter_number": "8675309"
26
- },
27
- "transaction_id": "00000000-0000-0000-0000-000000000000",
28
- "metadata": {
29
- "username": "auctane-next-day",
30
- "password": "password!",
31
- "meter_number": "8675309"
32
- }
33
- }
23
+ "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"}}
34
24
  }
35
25
  }
36
26
  },
@@ -42,17 +32,7 @@
42
32
  "schema": {
43
33
  "$ref": "#/components/schemas/RegisterResponse"
44
34
  },
45
- "example": {
46
- "credentials": {
47
- "username": "auctane-next-day",
48
- "password": "password!"
49
- },
50
- "metadata": {
51
- "username": "auctane-next-day",
52
- "password": "password!",
53
- "meter_number": "8675309"
54
- }
55
- }
35
+ "example": {"credentials":{"username":"auctane-next-day","password":"password!"},"metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
56
36
  }
57
37
  }
58
38
  }
@@ -61,7 +41,9 @@
61
41
  },
62
42
  "/CreateLabel": {
63
43
  "post": {
64
- "tags": ["Labels"],
44
+ "tags": [
45
+ "Labels"
46
+ ],
65
47
  "description": "This method creates a new label.",
66
48
  "operationId": "CreateLabel",
67
49
  "parameters": [
@@ -101,7 +83,9 @@
101
83
  },
102
84
  "/VoidLabels": {
103
85
  "post": {
104
- "tags": ["Labels"],
86
+ "tags": [
87
+ "Labels"
88
+ ],
105
89
  "description": "This method is used to void a previously created labels.",
106
90
  "operationId": "VoidLabels",
107
91
  "requestBody": {
@@ -130,7 +114,9 @@
130
114
  },
131
115
  "/CreateManifest": {
132
116
  "post": {
133
- "tags": ["Manifesting"],
117
+ "tags": [
118
+ "Manifesting"
119
+ ],
134
120
  "description": "This method creates an end-of-day manifest and should be implemented by carrier apps that support\r\nend-of-day manifesting.",
135
121
  "operationId": "CreateManifest",
136
122
  "requestBody": {
@@ -159,7 +145,9 @@
159
145
  },
160
146
  "/GetManifest": {
161
147
  "post": {
162
- "tags": ["Manifesting"],
148
+ "tags": [
149
+ "Manifesting"
150
+ ],
163
151
  "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.",
164
152
  "operationId": "GetManifest",
165
153
  "requestBody": {
@@ -188,7 +176,9 @@
188
176
  },
189
177
  "/ValidateInboundData": {
190
178
  "post": {
191
- "tags": ["Normalize Inbound Data"],
179
+ "tags": [
180
+ "Normalize Inbound Data"
181
+ ],
192
182
  "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",
193
183
  "operationId": "ValidateInboundData",
194
184
  "requestBody": {
@@ -198,22 +188,7 @@
198
188
  "schema": {
199
189
  "$ref": "#/components/schemas/ValidateInboundDataRequest"
200
190
  },
201
- "example": {
202
- "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
203
- "headers": {
204
- "content-type": ["application/json"],
205
- "X-Signature": [
206
- "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
207
- "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
208
- ]
209
- },
210
- "transaction_id": "00000000-0000-0000-0000-000000000000",
211
- "metadata": {
212
- "username": "auctane-next-day",
213
- "password": "password!",
214
- "meter_number": "8675309"
215
- }
216
- }
191
+ "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"}}
217
192
  }
218
193
  }
219
194
  },
@@ -228,9 +203,7 @@
228
203
  "examples": {
229
204
  "Tracking": {
230
205
  "summary": "Tracking",
231
- "value": {
232
- "content_types": ["tracking"]
233
- }
206
+ "value": {"content_types":["tracking"]}
234
207
  }
235
208
  }
236
209
  }
@@ -241,7 +214,9 @@
241
214
  },
242
215
  "/NormalizeTrackingData": {
243
216
  "post": {
244
- "tags": ["Normalize Inbound Data"],
217
+ "tags": [
218
+ "Normalize Inbound Data"
219
+ ],
245
220
  "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",
246
221
  "operationId": "NormalizeTrackingData",
247
222
  "requestBody": {
@@ -251,22 +226,7 @@
251
226
  "schema": {
252
227
  "$ref": "#/components/schemas/NormalizeTrackingDataRequest"
253
228
  },
254
- "example": {
255
- "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
256
- "headers": {
257
- "content-type": ["application/json"],
258
- "X-Signature": [
259
- "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
260
- "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
261
- ]
262
- },
263
- "transaction_id": "00000000-0000-0000-0000-000000000000",
264
- "metadata": {
265
- "username": "auctane-next-day",
266
- "password": "password!",
267
- "meter_number": "8675309"
268
- }
269
- }
229
+ "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"}}
270
230
  }
271
231
  }
272
232
  },
@@ -281,28 +241,7 @@
281
241
  "examples": {
282
242
  "Delivered": {
283
243
  "summary": "Delivered",
284
- "value": {
285
- "tracking_info": [
286
- {
287
- "carrier_name": "UPS",
288
- "tracking_number": "12345678901234567890",
289
- "standardized_status_code": "DE",
290
- "carrier_status_code": "11",
291
- "carrier_status_description": "Delivered",
292
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
293
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
294
- "service": {
295
- "code": "03",
296
- "name": "UPS® Ground"
297
- },
298
- "packaging": "package",
299
- "package_count": 1,
300
- "shipping_problem": false,
301
- "carrierEnum": 0
302
- }
303
- ],
304
- "update_method": "append"
305
- }
244
+ "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"}
306
245
  }
307
246
  }
308
247
  }
@@ -313,7 +252,9 @@
313
252
  },
314
253
  "/CreateNotification": {
315
254
  "post": {
316
- "tags": ["Shipment Notifications"],
255
+ "tags": [
256
+ "Shipment Notifications"
257
+ ],
317
258
  "operationId": "CreateNotification",
318
259
  "requestBody": {
319
260
  "content": {
@@ -340,7 +281,9 @@
340
281
  },
341
282
  "/CancelNotification": {
342
283
  "post": {
343
- "tags": ["Shipment Notifications"],
284
+ "tags": [
285
+ "Shipment Notifications"
286
+ ],
344
287
  "operationId": "CancelNotification",
345
288
  "requestBody": {
346
289
  "content": {
@@ -367,7 +310,9 @@
367
310
  },
368
311
  "/SchedulePickup": {
369
312
  "post": {
370
- "tags": ["Scheduled Pickups"],
313
+ "tags": [
314
+ "Scheduled Pickups"
315
+ ],
371
316
  "description": "This method is used to schedule a pickup with a carrier.",
372
317
  "operationId": "SchedulePickup",
373
318
  "requestBody": {
@@ -396,7 +341,9 @@
396
341
  },
397
342
  "/CancelPickup": {
398
343
  "post": {
399
- "tags": ["Scheduled Pickups"],
344
+ "tags": [
345
+ "Scheduled Pickups"
346
+ ],
400
347
  "operationId": "CancelPickup",
401
348
  "requestBody": {
402
349
  "content": {
@@ -423,7 +370,9 @@
423
370
  },
424
371
  "/GetRates": {
425
372
  "post": {
426
- "tags": ["Rating"],
373
+ "tags": [
374
+ "Rating"
375
+ ],
427
376
  "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.",
428
377
  "operationId": "GetRates",
429
378
  "requestBody": {
@@ -452,7 +401,9 @@
452
401
  },
453
402
  "/GetRelayPoints": {
454
403
  "post": {
455
- "tags": ["Relay Points"],
404
+ "tags": [
405
+ "Relay Points"
406
+ ],
456
407
  "description": "This method gets carrier relay points based on search criteria.",
457
408
  "operationId": "GetRelayPoints",
458
409
  "parameters": [
@@ -492,7 +443,9 @@
492
443
  },
493
444
  "/GetServicePoints": {
494
445
  "post": {
495
- "tags": ["Service Points"],
446
+ "tags": [
447
+ "Service Points"
448
+ ],
496
449
  "description": "This method gets carrier service points based on search criteria.",
497
450
  "operationId": "Get Service Points",
498
451
  "parameters": [
@@ -532,7 +485,9 @@
532
485
  },
533
486
  "/GetServicePoint": {
534
487
  "post": {
535
- "tags": ["Service Points"],
488
+ "tags": [
489
+ "Service Points"
490
+ ],
536
491
  "description": "This method gets a carrier service point by id",
537
492
  "operationId": "Get Service Point",
538
493
  "parameters": [
@@ -572,7 +527,9 @@
572
527
  },
573
528
  "/Track": {
574
529
  "post": {
575
- "tags": ["Tracking"],
530
+ "tags": [
531
+ "Tracking"
532
+ ],
576
533
  "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.",
577
534
  "operationId": "Track",
578
535
  "requestBody": {
@@ -582,32 +539,7 @@
582
539
  "schema": {
583
540
  "$ref": "#/components/schemas/TrackingRequest"
584
541
  },
585
- "example": {
586
- "tracking_number": "12345678901234567890",
587
- "is_return": false,
588
- "identifiers": [
589
- {
590
- "type": "tracking_number",
591
- "value": "12345678901234567890"
592
- },
593
- {
594
- "type": "carrier_transaction_id",
595
- "value": "US-12345678901234567890-1"
596
- }
597
- ],
598
- "attributes": [
599
- {
600
- "type": "marketplace_order_token",
601
- "value": "123456abcdefg7890"
602
- }
603
- ],
604
- "transaction_id": "00000000-0000-0000-0000-000000000000",
605
- "metadata": {
606
- "username": "auctane-next-day",
607
- "password": "password!",
608
- "meter_number": "8675309"
609
- }
610
- }
542
+ "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"}}
611
543
  }
612
544
  }
613
545
  },
@@ -622,211 +554,15 @@
622
554
  "examples": {
623
555
  "Delivered with Event History": {
624
556
  "summary": "Delivered with Event History",
625
- "value": {
626
- "tracking_info": {
627
- "carrier_name": "UPS",
628
- "tracking_number": "12345678901234567890",
629
- "standardized_status_code": "DE",
630
- "carrier_status_code": "11",
631
- "carrier_status_description": "Delivered",
632
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
633
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
634
- "weight": 500,
635
- "dimensions": {
636
- "length": 10,
637
- "width": 10,
638
- "height": 10
639
- },
640
- "service": {
641
- "code": "03",
642
- "name": "UPS® Ground"
643
- },
644
- "packaging": "package",
645
- "package_count": 1,
646
- "events": [
647
- {
648
- "event_datetime": "2021-08-08T21:15:00Z",
649
- "event_datetime_local": "2021-08-08T16:15:00",
650
- "event_code": "3",
651
- "description": "Order Processed: Ready for UPS",
652
- "city": "Austin",
653
- "state": "TX",
654
- "postal_code": "78756",
655
- "country": "US",
656
- "geo": {
657
- "lat": 30.31,
658
- "long": -97.74
659
- },
660
- "status_code": "AC"
661
- },
662
- {
663
- "event_datetime": "2021-08-09T09:15:00Z",
664
- "event_datetime_local": "2021-08-09T04:15:00",
665
- "event_code": "5",
666
- "description": "In Transit",
667
- "city": "Austin",
668
- "state": "TX",
669
- "postal_code": "78756",
670
- "country": "US",
671
- "geo": {
672
- "lat": 30.2,
673
- "long": -97.66
674
- },
675
- "status_code": "IT"
676
- },
677
- {
678
- "event_datetime": "2021-08-10T09:15:00Z",
679
- "event_datetime_local": "2021-08-10T04:15:00",
680
- "event_code": "6",
681
- "description": "On Vehicle for Delivery",
682
- "city": "Los Angeles",
683
- "state": "CA",
684
- "postal_code": "90045",
685
- "country": "US",
686
- "geo": {
687
- "lat": 33.95,
688
- "long": -118.38
689
- },
690
- "status_code": "IT"
691
- },
692
- {
693
- "event_datetime": "2021-08-10T15:15:00Z",
694
- "event_datetime_local": "2021-08-10T10:15:00",
695
- "event_code": "21",
696
- "description": "On Vehicle for Delivery Today",
697
- "city": "Los Angeles",
698
- "state": "CA",
699
- "postal_code": "90045",
700
- "country": "US",
701
- "geo": {
702
- "lat": 33.95,
703
- "long": -118.38
704
- },
705
- "status_code": "IT"
706
- },
707
- {
708
- "event_datetime": "2021-08-10T21:15:00Z",
709
- "event_datetime_local": "2021-08-10T16:15:00",
710
- "event_code": "22",
711
- "description": "First Attempt Made",
712
- "city": "El Segundo",
713
- "state": "CA",
714
- "postal_code": "90245",
715
- "country": "US",
716
- "geo": {
717
- "lat": 33.95,
718
- "long": -118.38
719
- },
720
- "status_code": "AT"
721
- },
722
- {
723
- "event_datetime": "2021-08-11T03:15:00Z",
724
- "event_datetime_local": "2021-08-10T22:15:00",
725
- "event_code": "21",
726
- "description": "On Vehicle for Delivery Today",
727
- "city": "Los Angeles",
728
- "state": "CA",
729
- "postal_code": "90045",
730
- "country": "US",
731
- "geo": {
732
- "lat": 33.95,
733
- "long": -118.38
734
- },
735
- "status_code": "IT"
736
- },
737
- {
738
- "event_datetime": "2021-08-11T21:15:00Z",
739
- "event_datetime_local": "2021-08-11T16:15:00",
740
- "event_code": "11",
741
- "description": "Delivered",
742
- "city": "El Segundo",
743
- "state": "CA",
744
- "postal_code": "90245",
745
- "country": "US",
746
- "geo": {
747
- "lat": 33.95,
748
- "long": -118.38
749
- },
750
- "status_code": "DE"
751
- }
752
- ],
753
- "shipping_problem": false,
754
- "carrierEnum": 0
755
- }
756
- }
557
+ "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}}
757
558
  },
758
559
  "Not Yet in System": {
759
560
  "summary": "Not Yet in System",
760
- "value": {
761
- "tracking_info": {
762
- "carrier_name": "UPS",
763
- "tracking_number": "12345678901234567890",
764
- "standardized_status_code": "NY",
765
- "events": [],
766
- "shipping_problem": false,
767
- "carrierEnum": 0
768
- }
769
- }
561
+ "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"NY","events":[],"shipping_problem":false,"carrierEnum":0}}
770
562
  },
771
563
  "Fatal Exception": {
772
564
  "summary": "Fatal Exception",
773
- "value": {
774
- "tracking_info": {
775
- "carrier_name": "UPS",
776
- "tracking_number": "12345678901234567890",
777
- "standardized_status_code": "EX",
778
- "carrier_status_code": "64",
779
- "carrier_status_description": "Delivery Refused",
780
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
781
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
782
- "weight": 500,
783
- "dimensions": {
784
- "length": 10,
785
- "width": 10,
786
- "height": 10
787
- },
788
- "service": {
789
- "code": "03",
790
- "name": "UPS® Ground"
791
- },
792
- "packaging": "package",
793
- "package_count": 1,
794
- "events": [
795
- {
796
- "event_datetime": "2021-08-09T09:15:00Z",
797
- "event_datetime_local": "2021-08-09T04:15:00",
798
- "event_code": "5",
799
- "description": "In Transit",
800
- "city": "Austin",
801
- "state": "TX",
802
- "postal_code": "78756",
803
- "country": "US",
804
- "geo": {
805
- "lat": 30.2,
806
- "long": -97.66
807
- },
808
- "status_code": "IT"
809
- },
810
- {
811
- "event_datetime": "2021-08-11T21:15:00Z",
812
- "event_datetime_local": "2021-08-11T16:15:00",
813
- "event_code": "59",
814
- "description": "Delivery Refused",
815
- "city": "El Segundo",
816
- "state": "CA",
817
- "postal_code": "90245",
818
- "country": "US",
819
- "geo": {
820
- "lat": 33.95,
821
- "long": -118.38
822
- },
823
- "status_code": "EX"
824
- }
825
- ],
826
- "shipping_problem": false,
827
- "carrierEnum": 0
828
- }
829
- }
565
+ "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}}
830
566
  }
831
567
  }
832
568
  }
@@ -839,7 +575,10 @@
839
575
  "components": {
840
576
  "schemas": {
841
577
  "AddressBase": {
842
- "required": ["postal_code", "country_code"],
578
+ "required": [
579
+ "postal_code",
580
+ "country_code"
581
+ ],
843
582
  "type": "object",
844
583
  "properties": {
845
584
  "address_lines": {
@@ -874,11 +613,20 @@
874
613
  "additionalProperties": false
875
614
  },
876
615
  "AddressResidentialIndicator": {
877
- "enum": ["unknown", "yes", "no", "commercial", "residential"],
616
+ "enum": [
617
+ "unknown",
618
+ "yes",
619
+ "no",
620
+ "commercial",
621
+ "residential"
622
+ ],
878
623
  "type": "string"
879
624
  },
880
625
  "AddressWithContact": {
881
- "required": ["postal_code", "country_code"],
626
+ "required": [
627
+ "postal_code",
628
+ "country_code"
629
+ ],
882
630
  "type": "object",
883
631
  "allOf": [
884
632
  {
@@ -955,8 +703,10 @@
955
703
  "description": "Describes whether or not the shipment is requested to be delivered on a Saturday."
956
704
  },
957
705
  "tip": {
958
- "required": ["currency", "amount"],
959
- "type": "object",
706
+ "required": [
707
+ "currency",
708
+ "amount"
709
+ ],
960
710
  "properties": {
961
711
  "amount": {
962
712
  "type": "string",
@@ -971,7 +721,7 @@
971
721
  "nullable": true
972
722
  }
973
723
  },
974
- "additionalProperties": {},
724
+ "additionalProperties": { },
975
725
  "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."
976
726
  },
977
727
  "Authorization": {
@@ -994,7 +744,9 @@
994
744
  "additionalProperties": false
995
745
  },
996
746
  "BaseRequest": {
997
- "required": ["transaction_id"],
747
+ "required": [
748
+ "transaction_id"
749
+ ],
998
750
  "type": "object",
999
751
  "properties": {
1000
752
  "transaction_id": {
@@ -1007,7 +759,7 @@
1007
759
  },
1008
760
  "metadata": {
1009
761
  "type": "object",
1010
- "additionalProperties": {},
762
+ "additionalProperties": { },
1011
763
  "nullable": true
1012
764
  }
1013
765
  },
@@ -1018,7 +770,7 @@
1018
770
  "properties": {
1019
771
  "metadata": {
1020
772
  "type": "object",
1021
- "additionalProperties": {},
773
+ "additionalProperties": { },
1022
774
  "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.",
1023
775
  "nullable": true
1024
776
  }
@@ -1049,7 +801,10 @@
1049
801
  "type": "string"
1050
802
  },
1051
803
  "BillingLineItem": {
1052
- "required": ["billing_category", "amount"],
804
+ "required": [
805
+ "billing_category",
806
+ "amount"
807
+ ],
1053
808
  "type": "object",
1054
809
  "properties": {
1055
810
  "billing_category": {
@@ -1071,8 +826,10 @@
1071
826
  "nullable": true
1072
827
  },
1073
828
  "amount": {
1074
- "required": ["currency", "amount"],
1075
- "type": "object",
829
+ "required": [
830
+ "currency",
831
+ "amount"
832
+ ],
1076
833
  "properties": {
1077
834
  "amount": {
1078
835
  "type": "string",
@@ -1090,7 +847,10 @@
1090
847
  "additionalProperties": false
1091
848
  },
1092
849
  "BillTo": {
1093
- "required": ["postal_code", "country_code"],
850
+ "required": [
851
+ "postal_code",
852
+ "country_code"
853
+ ],
1094
854
  "type": "object",
1095
855
  "allOf": [
1096
856
  {
@@ -1111,12 +871,18 @@
1111
871
  "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.AddressWithContact since address fields are often required when associating billing to\r\nanother account. Additionally, this allows for a contact to be specified, if necessary."
1112
872
  },
1113
873
  "BillToParty": {
1114
- "enum": ["shipper", "recipient", "third_party_account"],
874
+ "enum": [
875
+ "shipper",
876
+ "recipient",
877
+ "third_party_account"
878
+ ],
1115
879
  "type": "string",
1116
880
  "description": "The type of party responsible for a given category of charges associated with a shipment, such as shipping charges or import duties."
1117
881
  },
1118
882
  "CancellationDetails": {
1119
- "required": ["reason"],
883
+ "required": [
884
+ "reason"
885
+ ],
1120
886
  "type": "object",
1121
887
  "properties": {
1122
888
  "reason": {
@@ -1151,7 +917,9 @@
1151
917
  "description": "An enumeration of common reasons cancellations occur"
1152
918
  },
1153
919
  "CancelNotificationRequest": {
1154
- "required": ["transaction_id"],
920
+ "required": [
921
+ "transaction_id"
922
+ ],
1155
923
  "type": "object",
1156
924
  "allOf": [
1157
925
  {
@@ -1197,7 +965,10 @@
1197
965
  "description": "The response to the cancellation of a pending shipment notification."
1198
966
  },
1199
967
  "CancelPickupRequest": {
1200
- "required": ["pickup_windows", "transaction_id"],
968
+ "required": [
969
+ "pickup_windows",
970
+ "transaction_id"
971
+ ],
1201
972
  "type": "object",
1202
973
  "allOf": [
1203
974
  {
@@ -1241,7 +1012,9 @@
1241
1012
  "description": "A request to cancel a previously scheduled pickup"
1242
1013
  },
1243
1014
  "CancelPickupResponse": {
1244
- "required": ["successful"],
1015
+ "required": [
1016
+ "successful"
1017
+ ],
1245
1018
  "type": "object",
1246
1019
  "allOf": [
1247
1020
  {
@@ -1455,7 +1228,7 @@
1455
1228
  },
1456
1229
  "tracking_url": {
1457
1230
  "type": "string",
1458
- "description": "The carrier specific tracking URL for this shipment; if a multi-package shipment, this should be the lead tracking URL.",
1231
+ "description": "The carrier specific tracking URL for this shipment; if a multi-package shipment, this should be\r\nthe lead tracking number.",
1459
1232
  "nullable": true
1460
1233
  },
1461
1234
  "trackable": {
@@ -1497,7 +1270,9 @@
1497
1270
  "description": "This model represents the response from a successful create label request."
1498
1271
  },
1499
1272
  "CreateManifestRequest": {
1500
- "required": ["transaction_id"],
1273
+ "required": [
1274
+ "transaction_id"
1275
+ ],
1501
1276
  "type": "object",
1502
1277
  "allOf": [
1503
1278
  {
@@ -1543,7 +1318,9 @@
1543
1318
  "description": "This model represents the request payload needed to manifest with a shipping provider."
1544
1319
  },
1545
1320
  "CreateManifestResponse": {
1546
- "required": ["manifests"],
1321
+ "required": [
1322
+ "manifests"
1323
+ ],
1547
1324
  "type": "object",
1548
1325
  "allOf": [
1549
1326
  {
@@ -1594,7 +1371,7 @@
1594
1371
  },
1595
1372
  "manifest_identifiers": {
1596
1373
  "type": "object",
1597
- "additionalProperties": {},
1374
+ "additionalProperties": { },
1598
1375
  "description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
1599
1376
  "nullable": true
1600
1377
  }
@@ -1603,7 +1380,9 @@
1603
1380
  "description": "This model represents the successful response for a create manifest request."
1604
1381
  },
1605
1382
  "CreateNotificationRequest": {
1606
- "required": ["transaction_id"],
1383
+ "required": [
1384
+ "transaction_id"
1385
+ ],
1607
1386
  "type": "object",
1608
1387
  "allOf": [
1609
1388
  {
@@ -1650,7 +1429,10 @@
1650
1429
  "description": "The response to a notification request."
1651
1430
  },
1652
1431
  "Credentials": {
1653
- "required": ["username", "password"],
1432
+ "required": [
1433
+ "username",
1434
+ "password"
1435
+ ],
1654
1436
  "type": "object",
1655
1437
  "properties": {
1656
1438
  "username": {
@@ -1666,7 +1448,9 @@
1666
1448
  "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."
1667
1449
  },
1668
1450
  "Customs": {
1669
- "required": ["customs_items"],
1451
+ "required": [
1452
+ "customs_items"
1453
+ ],
1670
1454
  "type": "object",
1671
1455
  "properties": {
1672
1456
  "contents": {
@@ -1684,8 +1468,10 @@
1684
1468
  "nullable": true
1685
1469
  },
1686
1470
  "buyer_shipping_amount_paid": {
1687
- "required": ["currency", "amount"],
1688
- "type": "object",
1471
+ "required": [
1472
+ "currency",
1473
+ "amount"
1474
+ ],
1689
1475
  "properties": {
1690
1476
  "amount": {
1691
1477
  "type": "string",
@@ -1700,8 +1486,10 @@
1700
1486
  "nullable": true
1701
1487
  },
1702
1488
  "duties_paid": {
1703
- "required": ["currency", "amount"],
1704
- "type": "object",
1489
+ "required": [
1490
+ "currency",
1491
+ "amount"
1492
+ ],
1705
1493
  "properties": {
1706
1494
  "amount": {
1707
1495
  "type": "string",
@@ -1717,6 +1505,11 @@
1717
1505
  },
1718
1506
  "bill_duties_to": {
1719
1507
  "$ref": "#/components/schemas/BillTo"
1508
+ },
1509
+ "declaration": {
1510
+ "type": "string",
1511
+ "description": "Declaration statement to be placed on the commercial invoice",
1512
+ "nullable": true
1720
1513
  }
1721
1514
  },
1722
1515
  "additionalProperties": false
@@ -1732,7 +1525,9 @@
1732
1525
  "type": "string"
1733
1526
  },
1734
1527
  "CustomsItem": {
1735
- "required": ["value"],
1528
+ "required": [
1529
+ "value"
1530
+ ],
1736
1531
  "type": "object",
1737
1532
  "properties": {
1738
1533
  "description": {
@@ -1746,8 +1541,10 @@
1746
1541
  "format": "int32"
1747
1542
  },
1748
1543
  "value": {
1749
- "required": ["currency", "amount"],
1750
- "type": "object",
1544
+ "required": [
1545
+ "currency",
1546
+ "amount"
1547
+ ],
1751
1548
  "properties": {
1752
1549
  "amount": {
1753
1550
  "type": "string",
@@ -1789,7 +1586,10 @@
1789
1586
  "description": "This model represents the customs declaration for a single item."
1790
1587
  },
1791
1588
  "CustomsNonDelivery": {
1792
- "enum": ["return_to_sender", "treat_as_abandoned"],
1589
+ "enum": [
1590
+ "return_to_sender",
1591
+ "treat_as_abandoned"
1592
+ ],
1793
1593
  "type": "string",
1794
1594
  "description": "What to do if the shipment is undeliverable."
1795
1595
  },
@@ -1838,7 +1638,10 @@
1838
1638
  "description": "This model represents the measurements for dimensions."
1839
1639
  },
1840
1640
  "DimensionUnit": {
1841
- "enum": ["inches", "centimeters"],
1641
+ "enum": [
1642
+ "inches",
1643
+ "centimeters"
1644
+ ],
1842
1645
  "type": "string",
1843
1646
  "description": "This model represents the supported units for dimensions."
1844
1647
  },
@@ -1850,7 +1653,11 @@
1850
1653
  "type": "string"
1851
1654
  },
1852
1655
  "Document": {
1853
- "required": ["type", "data", "format"],
1656
+ "required": [
1657
+ "type",
1658
+ "data",
1659
+ "format"
1660
+ ],
1854
1661
  "type": "object",
1855
1662
  "properties": {
1856
1663
  "type": {
@@ -1874,7 +1681,11 @@
1874
1681
  "description": "Container for a document."
1875
1682
  },
1876
1683
  "DocumentFormat": {
1877
- "enum": ["PDF", "ZPL", "PNG"],
1684
+ "enum": [
1685
+ "PDF",
1686
+ "ZPL",
1687
+ "PNG"
1688
+ ],
1878
1689
  "type": "string"
1879
1690
  },
1880
1691
  "DocumentType": {
@@ -1961,7 +1772,9 @@
1961
1772
  "description": "This contains information about the fulfillment plan for a set of items."
1962
1773
  },
1963
1774
  "GetManifestRequest": {
1964
- "required": ["transaction_id"],
1775
+ "required": [
1776
+ "transaction_id"
1777
+ ],
1965
1778
  "type": "object",
1966
1779
  "allOf": [
1967
1780
  {
@@ -1981,7 +1794,7 @@
1981
1794
  },
1982
1795
  "manifest_identifiers": {
1983
1796
  "type": "object",
1984
- "additionalProperties": {},
1797
+ "additionalProperties": { },
1985
1798
  "description": "Carrier specific data needed to retrieve Manifest results",
1986
1799
  "nullable": true
1987
1800
  },
@@ -2147,7 +1960,9 @@
2147
1960
  "description": "This model represents the payload sent to get relay points based on the provided search criteria."
2148
1961
  },
2149
1962
  "GetRelayPointsResponse": {
2150
- "required": ["relay_points"],
1963
+ "required": [
1964
+ "relay_points"
1965
+ ],
2151
1966
  "type": "object",
2152
1967
  "properties": {
2153
1968
  "relay_points": {
@@ -2162,7 +1977,9 @@
2162
1977
  "description": "Basic structure for a response to get relay points"
2163
1978
  },
2164
1979
  "GetServicePointRequest": {
2165
- "required": ["transaction_id"],
1980
+ "required": [
1981
+ "transaction_id"
1982
+ ],
2166
1983
  "type": "object",
2167
1984
  "allOf": [
2168
1985
  {
@@ -2198,7 +2015,9 @@
2198
2015
  "additionalProperties": false
2199
2016
  },
2200
2017
  "GetServicePointsRequest": {
2201
- "required": ["transaction_id"],
2018
+ "required": [
2019
+ "transaction_id"
2020
+ ],
2202
2021
  "type": "object",
2203
2022
  "allOf": [
2204
2023
  {
@@ -2263,7 +2082,10 @@
2263
2082
  "additionalProperties": false
2264
2083
  },
2265
2084
  "Identifier": {
2266
- "required": ["type", "value"],
2085
+ "required": [
2086
+ "type",
2087
+ "value"
2088
+ ],
2267
2089
  "type": "object",
2268
2090
  "properties": {
2269
2091
  "type": {
@@ -2281,11 +2103,18 @@
2281
2103
  "description": "A key value pair, allowing custom properties to be stored."
2282
2104
  },
2283
2105
  "InboundDataContentTypes": {
2284
- "enum": ["tracking"],
2106
+ "enum": [
2107
+ "tracking"
2108
+ ],
2285
2109
  "type": "string"
2286
2110
  },
2287
2111
  "InsuranceProviders": {
2288
- "enum": ["None", "ShipStation", "Carrier", "External"],
2112
+ "enum": [
2113
+ "None",
2114
+ "ShipStation",
2115
+ "Carrier",
2116
+ "External"
2117
+ ],
2289
2118
  "type": "string"
2290
2119
  },
2291
2120
  "LabelDownload": {
@@ -2299,7 +2128,10 @@
2299
2128
  "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."
2300
2129
  },
2301
2130
  "LabelLayouts": {
2302
- "enum": ["4x6", "letter"],
2131
+ "enum": [
2132
+ "4x6",
2133
+ "letter"
2134
+ ],
2303
2135
  "type": "string"
2304
2136
  },
2305
2137
  "LabelMessage": {
@@ -2428,11 +2260,18 @@
2428
2260
  "additionalProperties": false
2429
2261
  },
2430
2262
  "ManifestStatus": {
2431
- "enum": ["unknown", "in_progress", "completed", "failed"],
2263
+ "enum": [
2264
+ "unknown",
2265
+ "in_progress",
2266
+ "completed",
2267
+ "failed"
2268
+ ],
2432
2269
  "type": "string"
2433
2270
  },
2434
2271
  "NormalizeTrackingDataRequest": {
2435
- "required": ["transaction_id"],
2272
+ "required": [
2273
+ "transaction_id"
2274
+ ],
2436
2275
  "type": "object",
2437
2276
  "allOf": [
2438
2277
  {
@@ -2528,7 +2367,9 @@
2528
2367
  "description": "The times each day that the relay point is open, for example: \"11:00-13:00, 14:30-19:30\""
2529
2368
  },
2530
2369
  "Package": {
2531
- "required": ["insured_value"],
2370
+ "required": [
2371
+ "insured_value"
2372
+ ],
2532
2373
  "type": "object",
2533
2374
  "properties": {
2534
2375
  "package_code": {
@@ -2543,8 +2384,10 @@
2543
2384
  "$ref": "#/components/schemas/WeightDetails"
2544
2385
  },
2545
2386
  "insured_value": {
2546
- "required": ["currency", "amount"],
2547
- "type": "object",
2387
+ "required": [
2388
+ "currency",
2389
+ "amount"
2390
+ ],
2548
2391
  "properties": {
2549
2392
  "amount": {
2550
2393
  "type": "string",
@@ -2597,7 +2440,11 @@
2597
2440
  "description": "This model contains the confirmation information for a scheduled pickup."
2598
2441
  },
2599
2442
  "PickupContactDetails": {
2600
- "required": ["first_name", "email", "phone_number"],
2443
+ "required": [
2444
+ "first_name",
2445
+ "email",
2446
+ "phone_number"
2447
+ ],
2601
2448
  "type": "object",
2602
2449
  "properties": {
2603
2450
  "first_name": {
@@ -2674,7 +2521,12 @@
2674
2521
  "description": "Contains information regarding the service code for the pickup request and the packages that will be picked up"
2675
2522
  },
2676
2523
  "PickupWindow": {
2677
- "required": ["time_zone_iana", "pickup_date", "start_time", "end_time"],
2524
+ "required": [
2525
+ "time_zone_iana",
2526
+ "pickup_date",
2527
+ "start_time",
2528
+ "end_time"
2529
+ ],
2678
2530
  "type": "object",
2679
2531
  "properties": {
2680
2532
  "time_zone_iana": {
@@ -2708,7 +2560,10 @@
2708
2560
  "description": "This model represents a window of time a pickup could be made."
2709
2561
  },
2710
2562
  "PudoLocation": {
2711
- "required": ["postal_code", "country_code"],
2563
+ "required": [
2564
+ "postal_code",
2565
+ "country_code"
2566
+ ],
2712
2567
  "type": "object",
2713
2568
  "allOf": [
2714
2569
  {
@@ -2802,8 +2657,7 @@
2802
2657
  },
2803
2658
  "estimated_delivery_text": {
2804
2659
  "type": "string",
2805
- "description": "Estimated delivery text. It could be any text, a number, a date, etc.",
2806
- "example": "Monday by 11:00 PM",
2660
+ "description": "Estimated delivery text. It could be any text, a number, a date, etc.\r\nIf a number is sent, the UI appends \" days\"\r\n<example> If EstimatedDeliveryText is \"2\", the UI will display \"2 days\". ShipEngine does not append any text.</example><example> Monday by 11:00 PM</example>",
2807
2661
  "nullable": true
2808
2662
  }
2809
2663
  },
@@ -2811,7 +2665,9 @@
2811
2665
  "description": "This model represents a rate for a given service code."
2812
2666
  },
2813
2667
  "RawExternalSource": {
2814
- "required": ["marketplace_code"],
2668
+ "required": [
2669
+ "marketplace_code"
2670
+ ],
2815
2671
  "type": "object",
2816
2672
  "properties": {
2817
2673
  "marketplace_code": {
@@ -2824,7 +2680,10 @@
2824
2680
  "description": "This model represents a raw external source of information."
2825
2681
  },
2826
2682
  "RegisterRequest": {
2827
- "required": ["registration_info", "transaction_id"],
2683
+ "required": [
2684
+ "registration_info",
2685
+ "transaction_id"
2686
+ ],
2828
2687
  "type": "object",
2829
2688
  "allOf": [
2830
2689
  {
@@ -2834,7 +2693,7 @@
2834
2693
  "properties": {
2835
2694
  "registration_info": {
2836
2695
  "type": "object",
2837
- "additionalProperties": {},
2696
+ "additionalProperties": { },
2838
2697
  "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.",
2839
2698
  "nullable": true
2840
2699
  }
@@ -2843,7 +2702,10 @@
2843
2702
  "description": "This model represents the body of a request used to register a new user within ShipEngine."
2844
2703
  },
2845
2704
  "RegisterResponse": {
2846
- "required": ["credentials", "metadata"],
2705
+ "required": [
2706
+ "credentials",
2707
+ "metadata"
2708
+ ],
2847
2709
  "type": "object",
2848
2710
  "properties": {
2849
2711
  "credentials": {
@@ -2851,7 +2713,7 @@
2851
2713
  },
2852
2714
  "metadata": {
2853
2715
  "type": "object",
2854
- "additionalProperties": {},
2716
+ "additionalProperties": { },
2855
2717
  "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.",
2856
2718
  "nullable": true
2857
2719
  }
@@ -2944,7 +2806,10 @@
2944
2806
  "description": "The address information corresponding to a specific relay point"
2945
2807
  },
2946
2808
  "RelayPointDetails": {
2947
- "required": ["ship_to", "ship_from"],
2809
+ "required": [
2810
+ "ship_to",
2811
+ "ship_from"
2812
+ ],
2948
2813
  "type": "object",
2949
2814
  "properties": {
2950
2815
  "ship_to": {
@@ -2975,7 +2840,9 @@
2975
2840
  "description": "Used for generic downloads, containing the resource itself or a link to where it can be found"
2976
2841
  },
2977
2842
  "ReturnLabelDetails": {
2978
- "required": ["rma_number"],
2843
+ "required": [
2844
+ "rma_number"
2845
+ ],
2979
2846
  "type": "object",
2980
2847
  "properties": {
2981
2848
  "rma_number": {
@@ -2988,7 +2855,10 @@
2988
2855
  "description": "Return Label Information (Added 1.13)"
2989
2856
  },
2990
2857
  "SchedulePickupRequest": {
2991
- "required": ["requested_pickup_window", "transaction_id"],
2858
+ "required": [
2859
+ "requested_pickup_window",
2860
+ "transaction_id"
2861
+ ],
2992
2862
  "type": "object",
2993
2863
  "allOf": [
2994
2864
  {
@@ -3013,7 +2883,9 @@
3013
2883
  "description": "A request to schedule a pickup with a carrier"
3014
2884
  },
3015
2885
  "SchedulePickupResponse": {
3016
- "required": ["pickup_windows"],
2886
+ "required": [
2887
+ "pickup_windows"
2888
+ ],
3017
2889
  "type": "object",
3018
2890
  "allOf": [
3019
2891
  {
@@ -3085,7 +2957,10 @@
3085
2957
  "additionalProperties": false
3086
2958
  },
3087
2959
  "SearchRadiusUnit": {
3088
- "enum": ["miles", "kilometers"],
2960
+ "enum": [
2961
+ "miles",
2962
+ "kilometers"
2963
+ ],
3089
2964
  "type": "string"
3090
2965
  },
3091
2966
  "Service": {
@@ -3129,7 +3004,10 @@
3129
3004
  "additionalProperties": false
3130
3005
  },
3131
3006
  "ServicePointAddress": {
3132
- "required": ["postal_code", "country_code"],
3007
+ "required": [
3008
+ "postal_code",
3009
+ "country_code"
3010
+ ],
3133
3011
  "type": "object",
3134
3012
  "allOf": [
3135
3013
  {
@@ -3154,7 +3032,10 @@
3154
3032
  "type": "string"
3155
3033
  },
3156
3034
  "ServicePointResponseAddress": {
3157
- "required": ["postal_code", "country_code"],
3035
+ "required": [
3036
+ "postal_code",
3037
+ "country_code"
3038
+ ],
3158
3039
  "type": "object",
3159
3040
  "allOf": [
3160
3041
  {
@@ -3181,7 +3062,10 @@
3181
3062
  "additionalProperties": false
3182
3063
  },
3183
3064
  "ShipFrom": {
3184
- "required": ["postal_code", "country_code"],
3065
+ "required": [
3066
+ "postal_code",
3067
+ "country_code"
3068
+ ],
3185
3069
  "type": "object",
3186
3070
  "allOf": [
3187
3071
  {
@@ -3202,7 +3086,10 @@
3202
3086
  "description": "The shipment sender's address. It may or may not have been validated."
3203
3087
  },
3204
3088
  "ShipFromDisplay": {
3205
- "required": ["postal_code", "country_code"],
3089
+ "required": [
3090
+ "postal_code",
3091
+ "country_code"
3092
+ ],
3206
3093
  "type": "object",
3207
3094
  "allOf": [
3208
3095
  {
@@ -3303,7 +3190,10 @@
3303
3190
  "description": "This model represents a shipment that has already been shipped, and contains\r\nsummary information about the shipment."
3304
3191
  },
3305
3192
  "ShipTo": {
3306
- "required": ["postal_code", "country_code"],
3193
+ "required": [
3194
+ "postal_code",
3195
+ "country_code"
3196
+ ],
3307
3197
  "type": "object",
3308
3198
  "allOf": [
3309
3199
  {
@@ -3323,12 +3213,34 @@
3323
3213
  "additionalProperties": false
3324
3214
  },
3325
3215
  "StandardizedStatusCodes": {
3326
- "enum": ["UN", "AC", "IT", "DE", "EX", "AT", "NY", "SP"],
3216
+ "enum": [
3217
+ "UN",
3218
+ "AC",
3219
+ "IT",
3220
+ "DE",
3221
+ "EX",
3222
+ "AT",
3223
+ "NY",
3224
+ "SP"
3225
+ ],
3327
3226
  "type": "string",
3328
- "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\r\nSP - Delivered To Service Point"
3227
+ "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\r\nSP - Delivered To The Collection Location"
3329
3228
  },
3330
3229
  "TaxIdentificationType": {
3331
- "enum": ["tin", "ein", "ssn", "vat", "eori", "ioss", "pan", "voec"],
3230
+ "enum": [
3231
+ "tin",
3232
+ "ein",
3233
+ "ssn",
3234
+ "vat",
3235
+ "eori",
3236
+ "ioss",
3237
+ "pan",
3238
+ "voec",
3239
+ "pccc",
3240
+ "oss",
3241
+ "passport",
3242
+ "abn"
3243
+ ],
3332
3244
  "type": "string",
3333
3245
  "description": "Specifies the supported tax identification types."
3334
3246
  },
@@ -3447,7 +3359,10 @@
3447
3359
  "description": "This model represents a tracking event for a shipment."
3448
3360
  },
3449
3361
  "TrackingAttribute": {
3450
- "required": ["type", "value"],
3362
+ "required": [
3363
+ "type",
3364
+ "value"
3365
+ ],
3451
3366
  "type": "object",
3452
3367
  "properties": {
3453
3368
  "type": {
@@ -3480,7 +3395,9 @@
3480
3395
  "description": "This model represents a key value pair for identifying a shipment for tracking."
3481
3396
  },
3482
3397
  "TrackingInfo": {
3483
- "required": ["standardized_status_code"],
3398
+ "required": [
3399
+ "standardized_status_code"
3400
+ ],
3484
3401
  "type": "object",
3485
3402
  "properties": {
3486
3403
  "carrier_name": {
@@ -3578,7 +3495,9 @@
3578
3495
  "description": "This model represents tracking information for a shipment."
3579
3496
  },
3580
3497
  "TrackingRequest": {
3581
- "required": ["transaction_id"],
3498
+ "required": [
3499
+ "transaction_id"
3500
+ ],
3582
3501
  "type": "object",
3583
3502
  "allOf": [
3584
3503
  {
@@ -3607,7 +3526,9 @@
3607
3526
  "description": "This model represents the payload that is sent to request tracking information."
3608
3527
  },
3609
3528
  "TrackingResponse": {
3610
- "required": ["tracking_info"],
3529
+ "required": [
3530
+ "tracking_info"
3531
+ ],
3611
3532
  "type": "object",
3612
3533
  "allOf": [
3613
3534
  {
@@ -3623,11 +3544,16 @@
3623
3544
  "description": "This model represents the successful response from a tracking request."
3624
3545
  },
3625
3546
  "UpdateMethods": {
3626
- "enum": ["append", "replace"],
3547
+ "enum": [
3548
+ "append",
3549
+ "replace"
3550
+ ],
3627
3551
  "type": "string"
3628
3552
  },
3629
3553
  "ValidateInboundDataRequest": {
3630
- "required": ["transaction_id"],
3554
+ "required": [
3555
+ "transaction_id"
3556
+ ],
3631
3557
  "type": "object",
3632
3558
  "allOf": [
3633
3559
  {
@@ -3676,7 +3602,10 @@
3676
3602
  "description": "This model represents the successful response from a validate inbound data request."
3677
3603
  },
3678
3604
  "VoidLabelsRequest": {
3679
- "required": ["void_requests", "transaction_id"],
3605
+ "required": [
3606
+ "void_requests",
3607
+ "transaction_id"
3608
+ ],
3680
3609
  "type": "object",
3681
3610
  "allOf": [
3682
3611
  {
@@ -3697,7 +3626,9 @@
3697
3626
  "description": "This model represents the payload sent to void a set of labels."
3698
3627
  },
3699
3628
  "VoidLabelsResponse": {
3700
- "required": ["void_responses"],
3629
+ "required": [
3630
+ "void_responses"
3631
+ ],
3701
3632
  "type": "object",
3702
3633
  "allOf": [
3703
3634
  {
@@ -3718,7 +3649,10 @@
3718
3649
  "description": "This model represents the successful attempt to void a set of labels."
3719
3650
  },
3720
3651
  "VoidRequest": {
3721
- "required": ["void_request_id", "ship_from"],
3652
+ "required": [
3653
+ "void_request_id",
3654
+ "ship_from"
3655
+ ],
3722
3656
  "type": "object",
3723
3657
  "allOf": [
3724
3658
  {
@@ -3739,7 +3673,9 @@
3739
3673
  "description": "A request to void a particular label."
3740
3674
  },
3741
3675
  "VoidResponse": {
3742
- "required": ["void_request_id"],
3676
+ "required": [
3677
+ "void_request_id"
3678
+ ],
3743
3679
  "type": "object",
3744
3680
  "properties": {
3745
3681
  "void_request_id": {
@@ -3853,7 +3789,12 @@
3853
3789
  "description": "This model represents the weight of a package in its original unit, ounces, and grams."
3854
3790
  },
3855
3791
  "WeightUnit": {
3856
- "enum": ["grams", "ounces", "kilograms", "pounds"],
3792
+ "enum": [
3793
+ "grams",
3794
+ "ounces",
3795
+ "kilograms",
3796
+ "pounds"
3797
+ ],
3857
3798
  "type": "string",
3858
3799
  "description": "This model describes the possible units of weight."
3859
3800
  }
@@ -3901,4 +3842,4 @@
3901
3842
  "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
3902
3843
  }
3903
3844
  ]
3904
- }
3845
+ }