@shipengine/connect-carrier-api 4.19.0 → 4.21.0

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 (31) hide show
  1. package/lib/app/metadata/confirmation-type.d.ts +2 -1
  2. package/lib/app/metadata/confirmation-type.js +2 -0
  3. package/lib/app/metadata/confirmation-type.js.map +1 -1
  4. package/lib/app/metadata/shipping-option.d.ts +3 -1
  5. package/lib/app/metadata/shipping-option.js +2 -0
  6. package/lib/app/metadata/shipping-option.js.map +1 -1
  7. package/lib/models/advanced-options.d.ts +4 -0
  8. package/lib/models/advanced-options.js +4 -0
  9. package/lib/models/advanced-options.js.map +1 -1
  10. package/lib/models/index.d.ts +1 -0
  11. package/lib/models/index.js +1 -0
  12. package/lib/models/index.js.map +1 -1
  13. package/lib/models/native-rating-details.d.ts +35 -0
  14. package/lib/models/native-rating-details.js +3 -0
  15. package/lib/models/native-rating-details.js.map +1 -0
  16. package/lib/models/rates/rate.d.ts +3 -0
  17. package/lib/models/rates/rate.js +2 -0
  18. package/lib/models/rates/rate.js.map +1 -1
  19. package/lib/responses/create-label-response.d.ts +2 -1
  20. package/lib/responses/create-label-response.js +1 -0
  21. package/lib/responses/create-label-response.js.map +1 -1
  22. package/package.json +1 -1
  23. package/spec.json +310 -449
  24. package/src/app/metadata/confirmation-type.ts +2 -0
  25. package/src/app/metadata/shipping-option.ts +2 -0
  26. package/src/models/advanced-options.ts +4 -0
  27. package/src/models/index.ts +1 -0
  28. package/src/models/native-rating-details.ts +37 -0
  29. package/src/models/rates/rate.ts +3 -0
  30. package/src/responses/create-label-response.ts +2 -0
  31. package/tsconfig.tsbuildinfo +1 -1
package/spec.json CHANGED
@@ -3,7 +3,7 @@
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.31.0"
6
+ "version": "1.35.0"
7
7
  },
8
8
  "paths": {
9
9
  "/Register": {
@@ -20,19 +20,7 @@
20
20
  "schema": {
21
21
  "$ref": "#/components/schemas/ExampleRegisterRequest"
22
22
  },
23
- "example": {
24
- "registration_info": {
25
- "username": "auctane-next-day",
26
- "password": "password!",
27
- "meter_number": "8675309"
28
- },
29
- "transaction_id": "00000000-0000-0000-0000-000000000000",
30
- "metadata": {
31
- "username": "auctane-next-day",
32
- "password": "password!",
33
- "meter_number": "8675309"
34
- }
35
- }
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"}}
36
24
  }
37
25
  }
38
26
  },
@@ -44,17 +32,7 @@
44
32
  "schema": {
45
33
  "$ref": "#/components/schemas/RegisterResponse"
46
34
  },
47
- "example": {
48
- "credentials": {
49
- "username": "auctane-next-day",
50
- "password": "password!"
51
- },
52
- "metadata": {
53
- "username": "auctane-next-day",
54
- "password": "password!",
55
- "meter_number": "8675309"
56
- }
57
- }
35
+ "example": {"credentials":{"username":"auctane-next-day","password":"password!"},"metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
58
36
  }
59
37
  }
60
38
  }
@@ -210,24 +188,7 @@
210
188
  "schema": {
211
189
  "$ref": "#/components/schemas/ValidateInboundDataRequest"
212
190
  },
213
- "example": {
214
- "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
215
- "headers": {
216
- "content-type": [
217
- "application/json"
218
- ],
219
- "X-Signature": [
220
- "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
221
- "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
222
- ]
223
- },
224
- "transaction_id": "00000000-0000-0000-0000-000000000000",
225
- "metadata": {
226
- "username": "auctane-next-day",
227
- "password": "password!",
228
- "meter_number": "8675309"
229
- }
230
- }
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"}}
231
192
  }
232
193
  }
233
194
  },
@@ -242,11 +203,7 @@
242
203
  "examples": {
243
204
  "Tracking": {
244
205
  "summary": "Tracking",
245
- "value": {
246
- "content_types": [
247
- "tracking"
248
- ]
249
- }
206
+ "value": {"content_types":["tracking"]}
250
207
  }
251
208
  }
252
209
  }
@@ -269,24 +226,7 @@
269
226
  "schema": {
270
227
  "$ref": "#/components/schemas/NormalizeTrackingDataRequest"
271
228
  },
272
- "example": {
273
- "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
274
- "headers": {
275
- "content-type": [
276
- "application/json"
277
- ],
278
- "X-Signature": [
279
- "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
280
- "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
281
- ]
282
- },
283
- "transaction_id": "00000000-0000-0000-0000-000000000000",
284
- "metadata": {
285
- "username": "auctane-next-day",
286
- "password": "password!",
287
- "meter_number": "8675309"
288
- }
289
- }
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"}}
290
230
  }
291
231
  }
292
232
  },
@@ -301,28 +241,7 @@
301
241
  "examples": {
302
242
  "Delivered": {
303
243
  "summary": "Delivered",
304
- "value": {
305
- "tracking_info": [
306
- {
307
- "carrier_name": "UPS",
308
- "tracking_number": "12345678901234567890",
309
- "standardized_status_code": "DE",
310
- "carrier_status_code": "11",
311
- "carrier_status_description": "Delivered",
312
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
313
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
314
- "service": {
315
- "code": "03",
316
- "name": "UPS® Ground"
317
- },
318
- "packaging": "package",
319
- "package_count": 1,
320
- "shipping_problem": false,
321
- "carrierEnum": 0
322
- }
323
- ],
324
- "update_method": "append"
325
- }
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"}
326
245
  }
327
246
  }
328
247
  }
@@ -649,32 +568,7 @@
649
568
  "schema": {
650
569
  "$ref": "#/components/schemas/TrackingRequest"
651
570
  },
652
- "example": {
653
- "tracking_number": "12345678901234567890",
654
- "is_return": false,
655
- "identifiers": [
656
- {
657
- "type": "tracking_number",
658
- "value": "12345678901234567890"
659
- },
660
- {
661
- "type": "carrier_transaction_id",
662
- "value": "US-12345678901234567890-1"
663
- }
664
- ],
665
- "attributes": [
666
- {
667
- "type": "marketplace_order_token",
668
- "value": "123456abcdefg7890"
669
- }
670
- ],
671
- "transaction_id": "00000000-0000-0000-0000-000000000000",
672
- "metadata": {
673
- "username": "auctane-next-day",
674
- "password": "password!",
675
- "meter_number": "8675309"
676
- }
677
- }
571
+ "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"}}
678
572
  }
679
573
  }
680
574
  },
@@ -689,222 +583,15 @@
689
583
  "examples": {
690
584
  "Delivered with Event History": {
691
585
  "summary": "Delivered with Event History",
692
- "value": {
693
- "tracking_info": {
694
- "carrier_name": "UPS",
695
- "tracking_number": "12345678901234567890",
696
- "standardized_status_code": "DE",
697
- "carrier_status_code": "D",
698
- "carrier_detail_code": "FS",
699
- "carrier_status_description": "Delivered",
700
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
701
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
702
- "weight": 500.0,
703
- "dimensions": {
704
- "length": 10.0,
705
- "width": 10.0,
706
- "height": 10.0
707
- },
708
- "service": {
709
- "code": "03",
710
- "name": "UPS® Ground"
711
- },
712
- "packaging": "package",
713
- "package_count": 1,
714
- "events": [
715
- {
716
- "event_datetime": "2021-08-08T21:15:00Z",
717
- "event_datetime_local": "2021-08-08T16:15:00",
718
- "event_code": "M",
719
- "carrier_detail_code": "DP",
720
- "description": "Order Processed: Ready for UPS",
721
- "city": "Austin",
722
- "state": "TX",
723
- "postal_code": "78756",
724
- "country": "US",
725
- "geo": {
726
- "lat": 30.31,
727
- "long": -97.74
728
- },
729
- "status_code": "AC"
730
- },
731
- {
732
- "event_datetime": "2021-08-09T09:15:00Z",
733
- "event_datetime_local": "2021-08-09T04:15:00",
734
- "event_code": "I",
735
- "carrier_detail_code": "MY",
736
- "description": "In Transit",
737
- "city": "Austin",
738
- "state": "TX",
739
- "postal_code": "78756",
740
- "country": "US",
741
- "geo": {
742
- "lat": 30.2,
743
- "long": -97.66
744
- },
745
- "status_code": "IT"
746
- },
747
- {
748
- "event_datetime": "2021-08-10T09:15:00Z",
749
- "event_datetime_local": "2021-08-10T04:15:00",
750
- "event_code": "I",
751
- "carrier_detail_code": "DS",
752
- "description": "On Vehicle for Delivery",
753
- "city": "Los Angeles",
754
- "state": "CA",
755
- "postal_code": "90045",
756
- "country": "US",
757
- "geo": {
758
- "lat": 33.95,
759
- "long": -118.38
760
- },
761
- "status_code": "IT"
762
- },
763
- {
764
- "event_datetime": "2021-08-10T15:15:00Z",
765
- "event_datetime_local": "2021-08-10T10:15:00",
766
- "event_code": "I",
767
- "carrier_detail_code": "OF",
768
- "description": "On Vehicle for Delivery Today",
769
- "city": "Los Angeles",
770
- "state": "CA",
771
- "postal_code": "90045",
772
- "country": "US",
773
- "geo": {
774
- "lat": 33.95,
775
- "long": -118.38
776
- },
777
- "status_code": "IT"
778
- },
779
- {
780
- "event_datetime": "2021-08-10T21:15:00Z",
781
- "event_datetime_local": "2021-08-10T16:15:00",
782
- "event_code": "I",
783
- "carrier_detail_code": "QS",
784
- "description": "First Attempt Made",
785
- "city": "El Segundo",
786
- "state": "CA",
787
- "postal_code": "90245",
788
- "country": "US",
789
- "geo": {
790
- "lat": 33.95,
791
- "long": -118.38
792
- },
793
- "status_code": "AT"
794
- },
795
- {
796
- "event_datetime": "2021-08-11T03:15:00Z",
797
- "event_datetime_local": "2021-08-10T22:15:00",
798
- "event_code": "I",
799
- "carrier_detail_code": "OF",
800
- "description": "On Vehicle for Delivery Today",
801
- "city": "Los Angeles",
802
- "state": "CA",
803
- "postal_code": "90045",
804
- "country": "US",
805
- "geo": {
806
- "lat": 33.95,
807
- "long": -118.38
808
- },
809
- "status_code": "IT"
810
- },
811
- {
812
- "event_datetime": "2021-08-11T21:15:00Z",
813
- "event_datetime_local": "2021-08-11T16:15:00",
814
- "event_code": "D",
815
- "carrier_detail_code": "FS",
816
- "description": "Delivered",
817
- "city": "El Segundo",
818
- "state": "CA",
819
- "postal_code": "90245",
820
- "country": "US",
821
- "geo": {
822
- "lat": 33.95,
823
- "long": -118.38
824
- },
825
- "status_code": "DE"
826
- }
827
- ],
828
- "shipping_problem": false,
829
- "carrierEnum": 0
830
- }
831
- }
586
+ "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"D","carrier_detail_code":"FS","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":"M","carrier_detail_code":"DP","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":"I","carrier_detail_code":"MY","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":"I","carrier_detail_code":"DS","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":"I","carrier_detail_code":"OF","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":"I","carrier_detail_code":"QS","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":"I","carrier_detail_code":"OF","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":"D","carrier_detail_code":"FS","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}}
832
587
  },
833
588
  "Not Yet in System": {
834
589
  "summary": "Not Yet in System",
835
- "value": {
836
- "tracking_info": {
837
- "carrier_name": "UPS",
838
- "tracking_number": "12345678901234567890",
839
- "standardized_status_code": "NY",
840
- "events": [],
841
- "shipping_problem": false,
842
- "carrierEnum": 0
843
- }
844
- }
590
+ "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"NY","events":[],"shipping_problem":false,"carrierEnum":0}}
845
591
  },
846
592
  "Fatal Exception": {
847
593
  "summary": "Fatal Exception",
848
- "value": {
849
- "tracking_info": {
850
- "carrier_name": "UPS",
851
- "tracking_number": "12345678901234567890",
852
- "standardized_status_code": "EX",
853
- "carrier_status_code": "X",
854
- "carrier_detail_code": "KR",
855
- "carrier_status_description": "Delivery Refused",
856
- "estimated_delivery_datetime": "2021-08-11T00:00:00",
857
- "actual_delivery_datetime": "2021-08-11T21:15:00Z",
858
- "weight": 500.0,
859
- "dimensions": {
860
- "length": 10.0,
861
- "width": 10.0,
862
- "height": 10.0
863
- },
864
- "service": {
865
- "code": "03",
866
- "name": "UPS® Ground"
867
- },
868
- "packaging": "package",
869
- "package_count": 1,
870
- "events": [
871
- {
872
- "event_datetime": "2021-08-09T09:15:00Z",
873
- "event_datetime_local": "2021-08-09T04:15:00",
874
- "event_code": "I",
875
- "carrier_detail_code": "MY",
876
- "description": "In Transit",
877
- "city": "Austin",
878
- "state": "TX",
879
- "postal_code": "78756",
880
- "country": "US",
881
- "geo": {
882
- "lat": 30.2,
883
- "long": -97.66
884
- },
885
- "status_code": "IT"
886
- },
887
- {
888
- "event_datetime": "2021-08-11T21:15:00Z",
889
- "event_datetime_local": "2021-08-11T16:15:00",
890
- "event_code": "X",
891
- "carrier_detail_code": "KR",
892
- "description": "Delivery Refused",
893
- "city": "El Segundo",
894
- "state": "CA",
895
- "postal_code": "90245",
896
- "country": "US",
897
- "geo": {
898
- "lat": 33.95,
899
- "long": -118.38
900
- },
901
- "status_code": "EX"
902
- }
903
- ],
904
- "shipping_problem": false,
905
- "carrierEnum": 0
906
- }
907
- }
594
+ "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"EX","carrier_status_code":"X","carrier_detail_code":"KR","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":"I","carrier_detail_code":"MY","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":"X","carrier_detail_code":"KR","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}}
908
595
  }
909
596
  }
910
597
  }
@@ -952,37 +639,21 @@
952
639
  "tags": [
953
640
  "Tracking"
954
641
  ],
955
- "description": "This method subscribes to tracking events for one or more identifiers. This endpoint initiate the subscription with the carrier's system.",
642
+ "description": "This method starts tracking for one or more shipment identifiers and creates subscriptions\r\nto push tracking updates to configured channels (webhook, SQS, or Kafka).\r\n \r\nThis method should be implemented if you support push-based tracking notifications where\r\nupdates are sent to configured endpoints rather than polling for updates.",
956
643
  "operationId": "StartTracking",
957
644
  "requestBody": {
958
- "description": "An object containing identifiers to subscribe to tracking events for.",
645
+ "description": "An object containing tracking identifiers and subscription channel configurations.",
959
646
  "content": {
960
647
  "application/json": {
961
648
  "schema": {
962
649
  "$ref": "#/components/schemas/StartTrackingRequest"
963
- },
964
- "example": {
965
- "identifiers": [
966
- {
967
- "type": "tracking_number",
968
- "value": "PL1234567890"
969
- },
970
- {
971
- "type": "tracking_number",
972
- "value": "PL0987654321"
973
- }
974
- ],
975
- "transaction_id": "771323cb-75eb-4e2a-bc11-fda608c6ade8",
976
- "authorization": {},
977
- "metadata": {},
978
- "connection_name": "a_connect_connection_name_string"
979
650
  }
980
651
  }
981
652
  }
982
653
  },
983
654
  "responses": {
984
655
  "200": {
985
- "description": "Successful subscription response with results for each identifier.",
656
+ "description": "Subscription results for each tracking identifier.",
986
657
  "content": {
987
658
  "application/json": {
988
659
  "schema": {
@@ -1260,9 +931,17 @@
1260
931
  "enable_document_upload": {
1261
932
  "type": "boolean",
1262
933
  "description": "Indicates whether document upload is enabled for the shipment."
934
+ },
935
+ "delivery_as_addressed": {
936
+ "type": "boolean",
937
+ "description": "Instructs the carrier to deliver the package only to the exact address provided."
938
+ },
939
+ "return_after_first_attempt": {
940
+ "type": "boolean",
941
+ "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails."
1263
942
  }
1264
943
  },
1265
- "additionalProperties": {},
944
+ "additionalProperties": { },
1266
945
  "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."
1267
946
  },
1268
947
  "Authorization": {
@@ -1625,6 +1304,15 @@
1625
1304
  },
1626
1305
  "additionalProperties": false
1627
1306
  },
1307
+ "ChannelProtocolType": {
1308
+ "enum": [
1309
+ "webhook",
1310
+ "sqs",
1311
+ "kafka"
1312
+ ],
1313
+ "type": "string",
1314
+ "description": "Types of subscription channels"
1315
+ },
1628
1316
  "CodPaymentType": {
1629
1317
  "enum": [
1630
1318
  "any",
@@ -1673,7 +1361,8 @@
1673
1361
  "Signature",
1674
1362
  "AdultSignature",
1675
1363
  "DirectSignature",
1676
- "DeliveryCode"
1364
+ "DeliveryCode",
1365
+ "AgeVerification16Plus"
1677
1366
  ],
1678
1367
  "type": "string"
1679
1368
  },
@@ -1911,6 +1600,9 @@
1911
1600
  },
1912
1601
  "carrier_weight": {
1913
1602
  "$ref": "#/components/schemas/CarrierWeight"
1603
+ },
1604
+ "native_rating_details": {
1605
+ "$ref": "#/components/schemas/NativeRatingDetails"
1914
1606
  }
1915
1607
  },
1916
1608
  "additionalProperties": false,
@@ -3132,29 +2824,6 @@
3132
2824
  "additionalProperties": false,
3133
2825
  "description": "A key value pair, allowing custom properties to be stored."
3134
2826
  },
3135
- "LimitIdentifier": {
3136
- "required": [
3137
- "type",
3138
- "value"
3139
- ],
3140
- "type": "object",
3141
- "properties": {
3142
- "type": {
3143
- "$ref": "#/components/schemas/LimitIdentifierType"
3144
- },
3145
- "value": {
3146
- "type": "string",
3147
- "description": "A unique identifier referencing the specific rate/usage limit configuration in the Rate Limiter."
3148
- }
3149
- }
3150
- },
3151
- "LimitIdentifierType": {
3152
- "type": "string",
3153
- "description": "The name of the functionality associated with this limit (e.g., \"track\").",
3154
- "enum": [
3155
- "track"
3156
- ]
3157
- },
3158
2827
  "ImportTrackingEventsRequest": {
3159
2828
  "required": [
3160
2829
  "transaction_id"
@@ -3278,6 +2947,29 @@
3278
2947
  ],
3279
2948
  "type": "string"
3280
2949
  },
2950
+ "KafkaProtocol": {
2951
+ "required": [
2952
+ "brokers",
2953
+ "topic"
2954
+ ],
2955
+ "type": "object",
2956
+ "properties": {
2957
+ "brokers": {
2958
+ "type": "array",
2959
+ "items": {
2960
+ "type": "string"
2961
+ },
2962
+ "description": "List of broker endpoints",
2963
+ "nullable": true
2964
+ },
2965
+ "topic": {
2966
+ "type": "string",
2967
+ "description": "Topic name",
2968
+ "nullable": true
2969
+ }
2970
+ },
2971
+ "additionalProperties": false
2972
+ },
3281
2973
  "LabelDownload": {
3282
2974
  "type": "object",
3283
2975
  "allOf": [
@@ -3370,6 +3062,31 @@
3370
3062
  "additionalProperties": false,
3371
3063
  "description": "This model represents a geographic point."
3372
3064
  },
3065
+ "LimitIdentifier": {
3066
+ "required": [
3067
+ "type",
3068
+ "value"
3069
+ ],
3070
+ "type": "object",
3071
+ "properties": {
3072
+ "type": {
3073
+ "$ref": "#/components/schemas/LimitIdentifierType"
3074
+ },
3075
+ "value": {
3076
+ "type": "string",
3077
+ "description": "A unique identifier referencing the specific rate/usage limit configuration in the Rate Limiter.",
3078
+ "nullable": true
3079
+ }
3080
+ },
3081
+ "additionalProperties": false
3082
+ },
3083
+ "LimitIdentifierType": {
3084
+ "enum": [
3085
+ "track"
3086
+ ],
3087
+ "type": "string",
3088
+ "description": "The name of the functionality associated with this limit (e.g., \"track\")."
3089
+ },
3373
3090
  "ListPickupsRequest": {
3374
3091
  "required": [
3375
3092
  "transaction_id"
@@ -3567,6 +3284,44 @@
3567
3284
  ],
3568
3285
  "type": "string"
3569
3286
  },
3287
+ "NativeRatingDetails": {
3288
+ "type": "object",
3289
+ "properties": {
3290
+ "key": {
3291
+ "type": "string",
3292
+ "description": "The complete key used to extract the rate value from the JSON configuration file.",
3293
+ "nullable": true
3294
+ },
3295
+ "zones": {
3296
+ "$ref": "#/components/schemas/Zones"
3297
+ },
3298
+ "service_name": {
3299
+ "type": "string",
3300
+ "description": "The name of the shipping service used for the shipment.",
3301
+ "nullable": true
3302
+ },
3303
+ "weight_class": {
3304
+ "$ref": "#/components/schemas/WeightClass"
3305
+ },
3306
+ "package_type": {
3307
+ "type": "string",
3308
+ "description": "The type of package used for the shipment.",
3309
+ "nullable": true
3310
+ },
3311
+ "date_key": {
3312
+ "type": "string",
3313
+ "description": "The effective date key used in certain Native Rating implementations.",
3314
+ "nullable": true
3315
+ },
3316
+ "platform": {
3317
+ "type": "string",
3318
+ "description": "Identifies the platform from which the shipment originated (e.g., ShipStation or ShipEngine).",
3319
+ "nullable": true
3320
+ }
3321
+ },
3322
+ "additionalProperties": false,
3323
+ "description": "Contains detailed information about the parameters used in Native Rating implementations to generate rate lookup keys."
3324
+ },
3570
3325
  "NormalizeTrackingDataRequest": {
3571
3326
  "required": [
3572
3327
  "transaction_id"
@@ -4032,9 +3787,24 @@
4032
3787
  "nullable": true
4033
3788
  }
4034
3789
  },
4035
- "additionalProperties": {},
3790
+ "additionalProperties": { },
4036
3791
  "description": "This model represents the product information for a single item."
4037
3792
  },
3793
+ "ProtocolBase": {
3794
+ "oneOf": [
3795
+ {
3796
+ "$ref": "#/components/schemas/WebhookProtocol"
3797
+ },
3798
+ {
3799
+ "$ref": "#/components/schemas/SqsProtocol"
3800
+ },
3801
+ {
3802
+ "$ref": "#/components/schemas/KafkaProtocol"
3803
+ }
3804
+ ],
3805
+ "additionalProperties": false,
3806
+ "description": "Base class for all subscription channel protocols"
3807
+ },
4038
3808
  "PudoLocation": {
4039
3809
  "required": [
4040
3810
  "postal_code",
@@ -4138,11 +3908,16 @@
4138
3908
  },
4139
3909
  "guaranteed_delivery_days": {
4140
3910
  "type": "integer",
3911
+ "description": "Guaranteed delivery days. The number of days it will take for the package to be delivered.",
4141
3912
  "format": "int32",
4142
- "nullable": true
3913
+ "nullable": true,
3914
+ "example": 1
4143
3915
  },
4144
3916
  "carrier_weight": {
4145
3917
  "$ref": "#/components/schemas/CarrierWeight"
3918
+ },
3919
+ "native_rating_details": {
3920
+ "$ref": "#/components/schemas/NativeRatingDetails"
4146
3921
  }
4147
3922
  },
4148
3923
  "additionalProperties": false,
@@ -4909,7 +4684,7 @@
4909
4684
  "nullable": true
4910
4685
  }
4911
4686
  },
4912
- "additionalProperties": {},
4687
+ "additionalProperties": { },
4913
4688
  "description": "This model represents the product of a package that has had a label generated for it"
4914
4689
  },
4915
4690
  "ShippedShipment": {
@@ -5010,6 +4785,25 @@
5010
4785
  },
5011
4786
  "additionalProperties": false
5012
4787
  },
4788
+ "SqsProtocol": {
4789
+ "required": [
4790
+ "queue_url"
4791
+ ],
4792
+ "type": "object",
4793
+ "properties": {
4794
+ "queue_url": {
4795
+ "type": "string",
4796
+ "description": "Queue URL",
4797
+ "nullable": true
4798
+ },
4799
+ "queue_name": {
4800
+ "type": "string",
4801
+ "description": "Queue name",
4802
+ "nullable": true
4803
+ }
4804
+ },
4805
+ "additionalProperties": false
4806
+ },
5013
4807
  "StandardizedStatusCodes": {
5014
4808
  "enum": [
5015
4809
  "UN",
@@ -5105,6 +4899,94 @@
5105
4899
  "type": "string",
5106
4900
  "description": "This represents the ShipEngine supported detail codes for a shipment."
5107
4901
  },
4902
+ "StartTrackingRequest": {
4903
+ "required": [
4904
+ "transaction_id"
4905
+ ],
4906
+ "type": "object",
4907
+ "allOf": [
4908
+ {
4909
+ "$ref": "#/components/schemas/BaseRequest"
4910
+ }
4911
+ ],
4912
+ "properties": {
4913
+ "identifiers": {
4914
+ "type": "array",
4915
+ "items": {
4916
+ "$ref": "#/components/schemas/TrackingIdentifier"
4917
+ },
4918
+ "description": "List of tracking identifiers to subscribe to",
4919
+ "nullable": true
4920
+ },
4921
+ "subscriptions": {
4922
+ "type": "array",
4923
+ "items": {
4924
+ "$ref": "#/components/schemas/SubscriptionChannel"
4925
+ },
4926
+ "description": "List of subscription types and protocols",
4927
+ "nullable": true
4928
+ }
4929
+ },
4930
+ "additionalProperties": false,
4931
+ "description": "Request to start tracking for one or more identifiers"
4932
+ },
4933
+ "StartTrackingResponse": {
4934
+ "type": "object",
4935
+ "allOf": [
4936
+ {
4937
+ "$ref": "#/components/schemas/BaseResponse"
4938
+ }
4939
+ ],
4940
+ "properties": {
4941
+ "subscription_results": {
4942
+ "type": "array",
4943
+ "items": {
4944
+ "$ref": "#/components/schemas/SubscriptionResult"
4945
+ },
4946
+ "description": "Results for each identifier subscription attempt",
4947
+ "nullable": true
4948
+ }
4949
+ },
4950
+ "additionalProperties": false,
4951
+ "description": "Response from starting tracking subscriptions"
4952
+ },
4953
+ "SubscriptionChannel": {
4954
+ "type": "object",
4955
+ "properties": {
4956
+ "type": {
4957
+ "$ref": "#/components/schemas/ChannelProtocolType"
4958
+ },
4959
+ "protocol": {
4960
+ "$ref": "#/components/schemas/ProtocolBase"
4961
+ }
4962
+ },
4963
+ "additionalProperties": false,
4964
+ "description": "Subscription channel configuration"
4965
+ },
4966
+ "SubscriptionResult": {
4967
+ "type": "object",
4968
+ "properties": {
4969
+ "identifier": {
4970
+ "$ref": "#/components/schemas/TrackingIdentifier"
4971
+ },
4972
+ "status": {
4973
+ "$ref": "#/components/schemas/SubscriptionStatus"
4974
+ },
4975
+ "error_message": {
4976
+ "type": "string",
4977
+ "description": "Message describing the result",
4978
+ "nullable": true
4979
+ }
4980
+ },
4981
+ "additionalProperties": false
4982
+ },
4983
+ "SubscriptionStatus": {
4984
+ "enum": [
4985
+ "SUCCESS",
4986
+ "FAILED"
4987
+ ],
4988
+ "type": "string"
4989
+ },
5108
4990
  "TaxDetails": {
5109
4991
  "type": "object",
5110
4992
  "properties": {
@@ -5491,83 +5373,6 @@
5491
5373
  "additionalProperties": false,
5492
5374
  "description": "This model represents the successful response from a tracking request."
5493
5375
  },
5494
- "StartTrackingRequest": {
5495
- "required": [
5496
- "identifiers",
5497
- "transaction_id"
5498
- ],
5499
- "type": "object",
5500
- "allOf": [
5501
- {
5502
- "$ref": "#/components/schemas/BaseRequest"
5503
- }
5504
- ],
5505
- "properties": {
5506
- "identifiers": {
5507
- "type": "array",
5508
- "items": {
5509
- "$ref": "#/components/schemas/TrackingIdentifier"
5510
- },
5511
- "description": "Array of identifiers (e.g., tracking numbers) to subscribe to tracking events for.",
5512
- "nullable": false
5513
- }
5514
- },
5515
- "additionalProperties": false,
5516
- "description": "This model represents the request payload for subscribing to tracking events for one or more identifiers."
5517
- },
5518
- "StartTrackingResponse": {
5519
- "required": [
5520
- "subscription_results"
5521
- ],
5522
- "type": "object",
5523
- "allOf": [
5524
- {
5525
- "$ref": "#/components/schemas/BaseResponse"
5526
- }
5527
- ],
5528
- "properties": {
5529
- "subscription_results": {
5530
- "type": "array",
5531
- "items": {
5532
- "$ref": "#/components/schemas/SubscriptionResult"
5533
- },
5534
- "description": "Array of subscription results, one for each identifier in the request.",
5535
- "nullable": false
5536
- }
5537
- },
5538
- "additionalProperties": false,
5539
- "description": "This model represents the response from a start tracking subscription request."
5540
- },
5541
- "SubscriptionResult": {
5542
- "required": [
5543
- "identifier",
5544
- "status"
5545
- ],
5546
- "type": "object",
5547
- "properties": {
5548
- "identifier": {
5549
- "$ref": "#/components/schemas/TrackingIdentifier"
5550
- },
5551
- "status": {
5552
- "$ref": "#/components/schemas/SubscriptionStatus"
5553
- },
5554
- "error_message": {
5555
- "type": "string",
5556
- "description": "Optional message providing additional details about the subscription result.",
5557
- "nullable": true
5558
- }
5559
- },
5560
- "additionalProperties": false,
5561
- "description": "This model represents the result of a tracking subscription attempt for a single identifier."
5562
- },
5563
- "SubscriptionStatus": {
5564
- "enum": [
5565
- "success",
5566
- "failed"
5567
- ],
5568
- "type": "string",
5569
- "description": "Status of the tracking subscription attempt.\nsuccess - Subscription was successful\nfailed - Subscription failed"
5570
- },
5571
5376
  "TransportMeanEnum": {
5572
5377
  "enum": [
5573
5378
  "ground",
@@ -5993,6 +5798,20 @@
5993
5798
  "additionalProperties": false,
5994
5799
  "description": "This model represents the success or failure of an individual label being voided."
5995
5800
  },
5801
+ "WebhookProtocol": {
5802
+ "required": [
5803
+ "url"
5804
+ ],
5805
+ "type": "object",
5806
+ "properties": {
5807
+ "url": {
5808
+ "type": "string",
5809
+ "description": "Webhook URL endpoint",
5810
+ "nullable": true
5811
+ }
5812
+ },
5813
+ "additionalProperties": false
5814
+ },
5996
5815
  "WeeklyHoursOfOperation": {
5997
5816
  "type": "object",
5998
5817
  "properties": {
@@ -6048,6 +5867,27 @@
6048
5867
  },
6049
5868
  "additionalProperties": false
6050
5869
  },
5870
+ "WeightClass": {
5871
+ "type": "object",
5872
+ "properties": {
5873
+ "key": {
5874
+ "type": "string",
5875
+ "description": "The complete weight class string.",
5876
+ "nullable": true
5877
+ },
5878
+ "min_weight": {
5879
+ "type": "string",
5880
+ "description": "The minimum weight value of the weight range.",
5881
+ "nullable": true
5882
+ },
5883
+ "max_weight": {
5884
+ "type": "string",
5885
+ "description": "The maximum weight value of the weight range.",
5886
+ "nullable": true
5887
+ }
5888
+ },
5889
+ "additionalProperties": false
5890
+ },
6051
5891
  "WeightDetails": {
6052
5892
  "type": "object",
6053
5893
  "properties": {
@@ -6096,6 +5936,27 @@
6096
5936
  }
6097
5937
  },
6098
5938
  "additionalProperties": false
5939
+ },
5940
+ "Zones": {
5941
+ "type": "object",
5942
+ "properties": {
5943
+ "key": {
5944
+ "type": "string",
5945
+ "description": "The complete zone string.",
5946
+ "nullable": true
5947
+ },
5948
+ "from_zone": {
5949
+ "type": "string",
5950
+ "description": "The source zone identifier.",
5951
+ "nullable": true
5952
+ },
5953
+ "to_zone": {
5954
+ "type": "string",
5955
+ "description": "The destination zone identifier.",
5956
+ "nullable": true
5957
+ }
5958
+ },
5959
+ "additionalProperties": false
6099
5960
  }
6100
5961
  }
6101
5962
  },
@@ -6145,4 +6006,4 @@
6145
6006
  "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
6146
6007
  }
6147
6008
  ]
6148
- }
6009
+ }