@shipengine/connect-carrier-api 4.19.0 → 4.20.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 (19) hide show
  1. package/lib/models/index.d.ts +1 -0
  2. package/lib/models/index.js +1 -0
  3. package/lib/models/index.js.map +1 -1
  4. package/lib/models/native-rating-details.d.ts +35 -0
  5. package/lib/models/native-rating-details.js +3 -0
  6. package/lib/models/native-rating-details.js.map +1 -0
  7. package/lib/models/rates/rate.d.ts +3 -0
  8. package/lib/models/rates/rate.js +2 -0
  9. package/lib/models/rates/rate.js.map +1 -1
  10. package/lib/responses/create-label-response.d.ts +2 -1
  11. package/lib/responses/create-label-response.js +1 -0
  12. package/lib/responses/create-label-response.js.map +1 -1
  13. package/package.json +1 -1
  14. package/spec.json +299 -447
  15. package/src/models/index.ts +1 -0
  16. package/src/models/native-rating-details.ts +37 -0
  17. package/src/models/rates/rate.ts +3 -0
  18. package/src/responses/create-label-response.ts +2 -0
  19. 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.34.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": {
@@ -1262,7 +933,7 @@
1262
933
  "description": "Indicates whether document upload is enabled for the shipment."
1263
934
  }
1264
935
  },
1265
- "additionalProperties": {},
936
+ "additionalProperties": { },
1266
937
  "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
938
  },
1268
939
  "Authorization": {
@@ -1625,6 +1296,15 @@
1625
1296
  },
1626
1297
  "additionalProperties": false
1627
1298
  },
1299
+ "ChannelProtocolType": {
1300
+ "enum": [
1301
+ "webhook",
1302
+ "sqs",
1303
+ "kafka"
1304
+ ],
1305
+ "type": "string",
1306
+ "description": "Types of subscription channels"
1307
+ },
1628
1308
  "CodPaymentType": {
1629
1309
  "enum": [
1630
1310
  "any",
@@ -1911,6 +1591,9 @@
1911
1591
  },
1912
1592
  "carrier_weight": {
1913
1593
  "$ref": "#/components/schemas/CarrierWeight"
1594
+ },
1595
+ "native_rating_details": {
1596
+ "$ref": "#/components/schemas/NativeRatingDetails"
1914
1597
  }
1915
1598
  },
1916
1599
  "additionalProperties": false,
@@ -3132,29 +2815,6 @@
3132
2815
  "additionalProperties": false,
3133
2816
  "description": "A key value pair, allowing custom properties to be stored."
3134
2817
  },
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
2818
  "ImportTrackingEventsRequest": {
3159
2819
  "required": [
3160
2820
  "transaction_id"
@@ -3278,6 +2938,29 @@
3278
2938
  ],
3279
2939
  "type": "string"
3280
2940
  },
2941
+ "KafkaProtocol": {
2942
+ "required": [
2943
+ "brokers",
2944
+ "topic"
2945
+ ],
2946
+ "type": "object",
2947
+ "properties": {
2948
+ "brokers": {
2949
+ "type": "array",
2950
+ "items": {
2951
+ "type": "string"
2952
+ },
2953
+ "description": "List of broker endpoints",
2954
+ "nullable": true
2955
+ },
2956
+ "topic": {
2957
+ "type": "string",
2958
+ "description": "Topic name",
2959
+ "nullable": true
2960
+ }
2961
+ },
2962
+ "additionalProperties": false
2963
+ },
3281
2964
  "LabelDownload": {
3282
2965
  "type": "object",
3283
2966
  "allOf": [
@@ -3370,6 +3053,31 @@
3370
3053
  "additionalProperties": false,
3371
3054
  "description": "This model represents a geographic point."
3372
3055
  },
3056
+ "LimitIdentifier": {
3057
+ "required": [
3058
+ "type",
3059
+ "value"
3060
+ ],
3061
+ "type": "object",
3062
+ "properties": {
3063
+ "type": {
3064
+ "$ref": "#/components/schemas/LimitIdentifierType"
3065
+ },
3066
+ "value": {
3067
+ "type": "string",
3068
+ "description": "A unique identifier referencing the specific rate/usage limit configuration in the Rate Limiter.",
3069
+ "nullable": true
3070
+ }
3071
+ },
3072
+ "additionalProperties": false
3073
+ },
3074
+ "LimitIdentifierType": {
3075
+ "enum": [
3076
+ "track"
3077
+ ],
3078
+ "type": "string",
3079
+ "description": "The name of the functionality associated with this limit (e.g., \"track\")."
3080
+ },
3373
3081
  "ListPickupsRequest": {
3374
3082
  "required": [
3375
3083
  "transaction_id"
@@ -3567,6 +3275,44 @@
3567
3275
  ],
3568
3276
  "type": "string"
3569
3277
  },
3278
+ "NativeRatingDetails": {
3279
+ "type": "object",
3280
+ "properties": {
3281
+ "key": {
3282
+ "type": "string",
3283
+ "description": "The complete key used to extract the rate value from the JSON configuration file.",
3284
+ "nullable": true
3285
+ },
3286
+ "zones": {
3287
+ "$ref": "#/components/schemas/Zones"
3288
+ },
3289
+ "service_name": {
3290
+ "type": "string",
3291
+ "description": "The name of the shipping service used for the shipment.",
3292
+ "nullable": true
3293
+ },
3294
+ "weight_class": {
3295
+ "$ref": "#/components/schemas/WeightClass"
3296
+ },
3297
+ "package_type": {
3298
+ "type": "string",
3299
+ "description": "The type of package used for the shipment.",
3300
+ "nullable": true
3301
+ },
3302
+ "date_key": {
3303
+ "type": "string",
3304
+ "description": "The effective date key used in certain Native Rating implementations.",
3305
+ "nullable": true
3306
+ },
3307
+ "platform": {
3308
+ "type": "string",
3309
+ "description": "Identifies the platform from which the shipment originated (e.g., ShipStation or ShipEngine).",
3310
+ "nullable": true
3311
+ }
3312
+ },
3313
+ "additionalProperties": false,
3314
+ "description": "Contains detailed information about the parameters used in Native Rating implementations to generate rate lookup keys."
3315
+ },
3570
3316
  "NormalizeTrackingDataRequest": {
3571
3317
  "required": [
3572
3318
  "transaction_id"
@@ -4032,9 +3778,24 @@
4032
3778
  "nullable": true
4033
3779
  }
4034
3780
  },
4035
- "additionalProperties": {},
3781
+ "additionalProperties": { },
4036
3782
  "description": "This model represents the product information for a single item."
4037
3783
  },
3784
+ "ProtocolBase": {
3785
+ "oneOf": [
3786
+ {
3787
+ "$ref": "#/components/schemas/WebhookProtocol"
3788
+ },
3789
+ {
3790
+ "$ref": "#/components/schemas/SqsProtocol"
3791
+ },
3792
+ {
3793
+ "$ref": "#/components/schemas/KafkaProtocol"
3794
+ }
3795
+ ],
3796
+ "additionalProperties": false,
3797
+ "description": "Base class for all subscription channel protocols"
3798
+ },
4038
3799
  "PudoLocation": {
4039
3800
  "required": [
4040
3801
  "postal_code",
@@ -4138,11 +3899,16 @@
4138
3899
  },
4139
3900
  "guaranteed_delivery_days": {
4140
3901
  "type": "integer",
3902
+ "description": "Guaranteed delivery days. The number of days it will take for the package to be delivered.",
4141
3903
  "format": "int32",
4142
- "nullable": true
3904
+ "nullable": true,
3905
+ "example": 1
4143
3906
  },
4144
3907
  "carrier_weight": {
4145
3908
  "$ref": "#/components/schemas/CarrierWeight"
3909
+ },
3910
+ "native_rating_details": {
3911
+ "$ref": "#/components/schemas/NativeRatingDetails"
4146
3912
  }
4147
3913
  },
4148
3914
  "additionalProperties": false,
@@ -4909,7 +4675,7 @@
4909
4675
  "nullable": true
4910
4676
  }
4911
4677
  },
4912
- "additionalProperties": {},
4678
+ "additionalProperties": { },
4913
4679
  "description": "This model represents the product of a package that has had a label generated for it"
4914
4680
  },
4915
4681
  "ShippedShipment": {
@@ -5010,6 +4776,25 @@
5010
4776
  },
5011
4777
  "additionalProperties": false
5012
4778
  },
4779
+ "SqsProtocol": {
4780
+ "required": [
4781
+ "queue_url"
4782
+ ],
4783
+ "type": "object",
4784
+ "properties": {
4785
+ "queue_url": {
4786
+ "type": "string",
4787
+ "description": "Queue URL",
4788
+ "nullable": true
4789
+ },
4790
+ "queue_name": {
4791
+ "type": "string",
4792
+ "description": "Queue name",
4793
+ "nullable": true
4794
+ }
4795
+ },
4796
+ "additionalProperties": false
4797
+ },
5013
4798
  "StandardizedStatusCodes": {
5014
4799
  "enum": [
5015
4800
  "UN",
@@ -5105,6 +4890,94 @@
5105
4890
  "type": "string",
5106
4891
  "description": "This represents the ShipEngine supported detail codes for a shipment."
5107
4892
  },
4893
+ "StartTrackingRequest": {
4894
+ "required": [
4895
+ "transaction_id"
4896
+ ],
4897
+ "type": "object",
4898
+ "allOf": [
4899
+ {
4900
+ "$ref": "#/components/schemas/BaseRequest"
4901
+ }
4902
+ ],
4903
+ "properties": {
4904
+ "identifiers": {
4905
+ "type": "array",
4906
+ "items": {
4907
+ "$ref": "#/components/schemas/TrackingIdentifier"
4908
+ },
4909
+ "description": "List of tracking identifiers to subscribe to",
4910
+ "nullable": true
4911
+ },
4912
+ "subscriptions": {
4913
+ "type": "array",
4914
+ "items": {
4915
+ "$ref": "#/components/schemas/SubscriptionChannel"
4916
+ },
4917
+ "description": "List of subscription types and protocols",
4918
+ "nullable": true
4919
+ }
4920
+ },
4921
+ "additionalProperties": false,
4922
+ "description": "Request to start tracking for one or more identifiers"
4923
+ },
4924
+ "StartTrackingResponse": {
4925
+ "type": "object",
4926
+ "allOf": [
4927
+ {
4928
+ "$ref": "#/components/schemas/BaseResponse"
4929
+ }
4930
+ ],
4931
+ "properties": {
4932
+ "subscription_results": {
4933
+ "type": "array",
4934
+ "items": {
4935
+ "$ref": "#/components/schemas/SubscriptionResult"
4936
+ },
4937
+ "description": "Results for each identifier subscription attempt",
4938
+ "nullable": true
4939
+ }
4940
+ },
4941
+ "additionalProperties": false,
4942
+ "description": "Response from starting tracking subscriptions"
4943
+ },
4944
+ "SubscriptionChannel": {
4945
+ "type": "object",
4946
+ "properties": {
4947
+ "type": {
4948
+ "$ref": "#/components/schemas/ChannelProtocolType"
4949
+ },
4950
+ "protocol": {
4951
+ "$ref": "#/components/schemas/ProtocolBase"
4952
+ }
4953
+ },
4954
+ "additionalProperties": false,
4955
+ "description": "Subscription channel configuration"
4956
+ },
4957
+ "SubscriptionResult": {
4958
+ "type": "object",
4959
+ "properties": {
4960
+ "identifier": {
4961
+ "$ref": "#/components/schemas/TrackingIdentifier"
4962
+ },
4963
+ "status": {
4964
+ "$ref": "#/components/schemas/SubscriptionStatus"
4965
+ },
4966
+ "error_message": {
4967
+ "type": "string",
4968
+ "description": "Message describing the result",
4969
+ "nullable": true
4970
+ }
4971
+ },
4972
+ "additionalProperties": false
4973
+ },
4974
+ "SubscriptionStatus": {
4975
+ "enum": [
4976
+ "SUCCESS",
4977
+ "FAILED"
4978
+ ],
4979
+ "type": "string"
4980
+ },
5108
4981
  "TaxDetails": {
5109
4982
  "type": "object",
5110
4983
  "properties": {
@@ -5491,83 +5364,6 @@
5491
5364
  "additionalProperties": false,
5492
5365
  "description": "This model represents the successful response from a tracking request."
5493
5366
  },
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
5367
  "TransportMeanEnum": {
5572
5368
  "enum": [
5573
5369
  "ground",
@@ -5993,6 +5789,20 @@
5993
5789
  "additionalProperties": false,
5994
5790
  "description": "This model represents the success or failure of an individual label being voided."
5995
5791
  },
5792
+ "WebhookProtocol": {
5793
+ "required": [
5794
+ "url"
5795
+ ],
5796
+ "type": "object",
5797
+ "properties": {
5798
+ "url": {
5799
+ "type": "string",
5800
+ "description": "Webhook URL endpoint",
5801
+ "nullable": true
5802
+ }
5803
+ },
5804
+ "additionalProperties": false
5805
+ },
5996
5806
  "WeeklyHoursOfOperation": {
5997
5807
  "type": "object",
5998
5808
  "properties": {
@@ -6048,6 +5858,27 @@
6048
5858
  },
6049
5859
  "additionalProperties": false
6050
5860
  },
5861
+ "WeightClass": {
5862
+ "type": "object",
5863
+ "properties": {
5864
+ "key": {
5865
+ "type": "string",
5866
+ "description": "The complete weight class string.",
5867
+ "nullable": true
5868
+ },
5869
+ "min_weight": {
5870
+ "type": "string",
5871
+ "description": "The minimum weight value of the weight range.",
5872
+ "nullable": true
5873
+ },
5874
+ "max_weight": {
5875
+ "type": "string",
5876
+ "description": "The maximum weight value of the weight range.",
5877
+ "nullable": true
5878
+ }
5879
+ },
5880
+ "additionalProperties": false
5881
+ },
6051
5882
  "WeightDetails": {
6052
5883
  "type": "object",
6053
5884
  "properties": {
@@ -6096,6 +5927,27 @@
6096
5927
  }
6097
5928
  },
6098
5929
  "additionalProperties": false
5930
+ },
5931
+ "Zones": {
5932
+ "type": "object",
5933
+ "properties": {
5934
+ "key": {
5935
+ "type": "string",
5936
+ "description": "The complete zone string.",
5937
+ "nullable": true
5938
+ },
5939
+ "from_zone": {
5940
+ "type": "string",
5941
+ "description": "The source zone identifier.",
5942
+ "nullable": true
5943
+ },
5944
+ "to_zone": {
5945
+ "type": "string",
5946
+ "description": "The destination zone identifier.",
5947
+ "nullable": true
5948
+ }
5949
+ },
5950
+ "additionalProperties": false
6099
5951
  }
6100
5952
  }
6101
5953
  },