@shipengine/connect-carrier-api 4.6.4 → 4.6.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 (2) hide show
  1. package/package.json +1 -1
  2. package/spec.json +306 -14
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "4.6.4",
3
+ "version": "4.6.6",
4
4
  "description": "This is the typescript/javascript definitions for carrier api",
5
5
  "homepage": "https://connect.shipengine.com",
6
6
  "main": "./lib/index.js",
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.20.0"
6
+ "version": "1.20.1"
7
7
  },
8
8
  "paths": {
9
9
  "/Register": {
@@ -20,7 +20,19 @@
20
20
  "schema": {
21
21
  "$ref": "#/components/schemas/ExampleRegisterRequest"
22
22
  },
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"}}
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
+ }
24
36
  }
25
37
  }
26
38
  },
@@ -32,7 +44,17 @@
32
44
  "schema": {
33
45
  "$ref": "#/components/schemas/RegisterResponse"
34
46
  },
35
- "example": {"credentials":{"username":"auctane-next-day","password":"password!"},"metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
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
+ }
36
58
  }
37
59
  }
38
60
  }
@@ -188,7 +210,19 @@
188
210
  "schema": {
189
211
  "$ref": "#/components/schemas/ValidateInboundDataRequest"
190
212
  },
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"}}
213
+ "example": {
214
+ "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
215
+ "headers": {
216
+ "content-type": [ "application/json" ],
217
+ "X-Signature": [ "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b", "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19" ]
218
+ },
219
+ "transaction_id": "00000000-0000-0000-0000-000000000000",
220
+ "metadata": {
221
+ "username": "auctane-next-day",
222
+ "password": "password!",
223
+ "meter_number": "8675309"
224
+ }
225
+ }
192
226
  }
193
227
  }
194
228
  },
@@ -203,7 +237,7 @@
203
237
  "examples": {
204
238
  "Tracking": {
205
239
  "summary": "Tracking",
206
- "value": {"content_types":["tracking"]}
240
+ "value": { "content_types": [ "tracking" ] }
207
241
  }
208
242
  }
209
243
  }
@@ -226,7 +260,19 @@
226
260
  "schema": {
227
261
  "$ref": "#/components/schemas/NormalizeTrackingDataRequest"
228
262
  },
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"}}
263
+ "example": {
264
+ "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
265
+ "headers": {
266
+ "content-type": [ "application/json" ],
267
+ "X-Signature": [ "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b", "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19" ]
268
+ },
269
+ "transaction_id": "00000000-0000-0000-0000-000000000000",
270
+ "metadata": {
271
+ "username": "auctane-next-day",
272
+ "password": "password!",
273
+ "meter_number": "8675309"
274
+ }
275
+ }
230
276
  }
231
277
  }
232
278
  },
@@ -241,7 +287,28 @@
241
287
  "examples": {
242
288
  "Delivered": {
243
289
  "summary": "Delivered",
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"}
290
+ "value": {
291
+ "tracking_info": [
292
+ {
293
+ "carrier_name": "UPS",
294
+ "tracking_number": "12345678901234567890",
295
+ "standardized_status_code": "DE",
296
+ "carrier_status_code": "11",
297
+ "carrier_status_description": "Delivered",
298
+ "estimated_delivery_datetime": "2021-08-11T00:00:00",
299
+ "actual_delivery_datetime": "2021-08-11T21:15:00Z",
300
+ "service": {
301
+ "code": "03",
302
+ "name": "UPS® Ground"
303
+ },
304
+ "packaging": "package",
305
+ "package_count": 1,
306
+ "shipping_problem": false,
307
+ "carrierEnum": 0
308
+ }
309
+ ],
310
+ "update_method": "append"
311
+ }
245
312
  }
246
313
  }
247
314
  }
@@ -539,7 +606,32 @@
539
606
  "schema": {
540
607
  "$ref": "#/components/schemas/TrackingRequest"
541
608
  },
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"}}
609
+ "example": {
610
+ "tracking_number": "12345678901234567890",
611
+ "is_return": false,
612
+ "identifiers": [
613
+ {
614
+ "type": "tracking_number",
615
+ "value": "12345678901234567890"
616
+ },
617
+ {
618
+ "type": "carrier_transaction_id",
619
+ "value": "US-12345678901234567890-1"
620
+ }
621
+ ],
622
+ "attributes": [
623
+ {
624
+ "type": "marketplace_order_token",
625
+ "value": "123456abcdefg7890"
626
+ }
627
+ ],
628
+ "transaction_id": "00000000-0000-0000-0000-000000000000",
629
+ "metadata": {
630
+ "username": "auctane-next-day",
631
+ "password": "password!",
632
+ "meter_number": "8675309"
633
+ }
634
+ }
543
635
  }
544
636
  }
545
637
  },
@@ -554,15 +646,211 @@
554
646
  "examples": {
555
647
  "Delivered with Event History": {
556
648
  "summary": "Delivered with Event History",
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}}
649
+ "value": {
650
+ "tracking_info": {
651
+ "carrier_name": "UPS",
652
+ "tracking_number": "12345678901234567890",
653
+ "standardized_status_code": "DE",
654
+ "carrier_status_code": "11",
655
+ "carrier_status_description": "Delivered",
656
+ "estimated_delivery_datetime": "2021-08-11T00:00:00",
657
+ "actual_delivery_datetime": "2021-08-11T21:15:00Z",
658
+ "weight": 500.0,
659
+ "dimensions": {
660
+ "length": 10.0,
661
+ "width": 10.0,
662
+ "height": 10.0
663
+ },
664
+ "service": {
665
+ "code": "03",
666
+ "name": "UPS® Ground"
667
+ },
668
+ "packaging": "package",
669
+ "package_count": 1,
670
+ "events": [
671
+ {
672
+ "event_datetime": "2021-08-08T21:15:00Z",
673
+ "event_datetime_local": "2021-08-08T16:15:00",
674
+ "event_code": "3",
675
+ "description": "Order Processed: Ready for UPS",
676
+ "city": "Austin",
677
+ "state": "TX",
678
+ "postal_code": "78756",
679
+ "country": "US",
680
+ "geo": {
681
+ "lat": 30.31,
682
+ "long": -97.74
683
+ },
684
+ "status_code": "AC"
685
+ },
686
+ {
687
+ "event_datetime": "2021-08-09T09:15:00Z",
688
+ "event_datetime_local": "2021-08-09T04:15:00",
689
+ "event_code": "5",
690
+ "description": "In Transit",
691
+ "city": "Austin",
692
+ "state": "TX",
693
+ "postal_code": "78756",
694
+ "country": "US",
695
+ "geo": {
696
+ "lat": 30.2,
697
+ "long": -97.66
698
+ },
699
+ "status_code": "IT"
700
+ },
701
+ {
702
+ "event_datetime": "2021-08-10T09:15:00Z",
703
+ "event_datetime_local": "2021-08-10T04:15:00",
704
+ "event_code": "6",
705
+ "description": "On Vehicle for Delivery",
706
+ "city": "Los Angeles",
707
+ "state": "CA",
708
+ "postal_code": "90045",
709
+ "country": "US",
710
+ "geo": {
711
+ "lat": 33.95,
712
+ "long": -118.38
713
+ },
714
+ "status_code": "IT"
715
+ },
716
+ {
717
+ "event_datetime": "2021-08-10T15:15:00Z",
718
+ "event_datetime_local": "2021-08-10T10:15:00",
719
+ "event_code": "21",
720
+ "description": "On Vehicle for Delivery Today",
721
+ "city": "Los Angeles",
722
+ "state": "CA",
723
+ "postal_code": "90045",
724
+ "country": "US",
725
+ "geo": {
726
+ "lat": 33.95,
727
+ "long": -118.38
728
+ },
729
+ "status_code": "IT"
730
+ },
731
+ {
732
+ "event_datetime": "2021-08-10T21:15:00Z",
733
+ "event_datetime_local": "2021-08-10T16:15:00",
734
+ "event_code": "22",
735
+ "description": "First Attempt Made",
736
+ "city": "El Segundo",
737
+ "state": "CA",
738
+ "postal_code": "90245",
739
+ "country": "US",
740
+ "geo": {
741
+ "lat": 33.95,
742
+ "long": -118.38
743
+ },
744
+ "status_code": "AT"
745
+ },
746
+ {
747
+ "event_datetime": "2021-08-11T03:15:00Z",
748
+ "event_datetime_local": "2021-08-10T22:15:00",
749
+ "event_code": "21",
750
+ "description": "On Vehicle for Delivery Today",
751
+ "city": "Los Angeles",
752
+ "state": "CA",
753
+ "postal_code": "90045",
754
+ "country": "US",
755
+ "geo": {
756
+ "lat": 33.95,
757
+ "long": -118.38
758
+ },
759
+ "status_code": "IT"
760
+ },
761
+ {
762
+ "event_datetime": "2021-08-11T21:15:00Z",
763
+ "event_datetime_local": "2021-08-11T16:15:00",
764
+ "event_code": "11",
765
+ "description": "Delivered",
766
+ "city": "El Segundo",
767
+ "state": "CA",
768
+ "postal_code": "90245",
769
+ "country": "US",
770
+ "geo": {
771
+ "lat": 33.95,
772
+ "long": -118.38
773
+ },
774
+ "status_code": "DE"
775
+ }
776
+ ],
777
+ "shipping_problem": false,
778
+ "carrierEnum": 0
779
+ }
780
+ }
558
781
  },
559
782
  "Not Yet in System": {
560
783
  "summary": "Not Yet in System",
561
- "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"NY","events":[],"shipping_problem":false,"carrierEnum":0}}
784
+ "value": {
785
+ "tracking_info": {
786
+ "carrier_name": "UPS",
787
+ "tracking_number": "12345678901234567890",
788
+ "standardized_status_code": "NY",
789
+ "events": [],
790
+ "shipping_problem": false,
791
+ "carrierEnum": 0
792
+ }
793
+ }
562
794
  },
563
795
  "Fatal Exception": {
564
796
  "summary": "Fatal Exception",
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}}
797
+ "value": {
798
+ "tracking_info": {
799
+ "carrier_name": "UPS",
800
+ "tracking_number": "12345678901234567890",
801
+ "standardized_status_code": "EX",
802
+ "carrier_status_code": "64",
803
+ "carrier_status_description": "Delivery Refused",
804
+ "estimated_delivery_datetime": "2021-08-11T00:00:00",
805
+ "actual_delivery_datetime": "2021-08-11T21:15:00Z",
806
+ "weight": 500.0,
807
+ "dimensions": {
808
+ "length": 10.0,
809
+ "width": 10.0,
810
+ "height": 10.0
811
+ },
812
+ "service": {
813
+ "code": "03",
814
+ "name": "UPS® Ground"
815
+ },
816
+ "packaging": "package",
817
+ "package_count": 1,
818
+ "events": [
819
+ {
820
+ "event_datetime": "2021-08-09T09:15:00Z",
821
+ "event_datetime_local": "2021-08-09T04:15:00",
822
+ "event_code": "5",
823
+ "description": "In Transit",
824
+ "city": "Austin",
825
+ "state": "TX",
826
+ "postal_code": "78756",
827
+ "country": "US",
828
+ "geo": {
829
+ "lat": 30.2,
830
+ "long": -97.66
831
+ },
832
+ "status_code": "IT"
833
+ },
834
+ {
835
+ "event_datetime": "2021-08-11T21:15:00Z",
836
+ "event_datetime_local": "2021-08-11T16:15:00",
837
+ "event_code": "59",
838
+ "description": "Delivery Refused",
839
+ "city": "El Segundo",
840
+ "state": "CA",
841
+ "postal_code": "90245",
842
+ "country": "US",
843
+ "geo": {
844
+ "lat": 33.95,
845
+ "long": -118.38
846
+ },
847
+ "status_code": "EX"
848
+ }
849
+ ],
850
+ "shipping_problem": false,
851
+ "carrierEnum": 0
852
+ }
853
+ }
566
854
  }
567
855
  }
568
856
  }
@@ -845,7 +1133,7 @@
845
1133
  "description": "Indicates whether the recipient should be notified of events related to the shipment."
846
1134
  }
847
1135
  },
848
- "additionalProperties": { },
1136
+ "additionalProperties": {},
849
1137
  "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."
850
1138
  },
851
1139
  "Authorization": {
@@ -3878,7 +4166,12 @@
3878
4166
  "nullable": true
3879
4167
  },
3880
4168
  "geolocation": {
3881
- "$ref": "#/components/schemas/Geolocation"
4169
+ "type": "array",
4170
+ "items": {
4171
+ "$ref": "#/components/schemas/Geolocation"
4172
+ },
4173
+ "description": "List of Geolocation objects to help identify the location.",
4174
+ "nullable": true
3882
4175
  }
3883
4176
  },
3884
4177
  "additionalProperties": false
@@ -4393,7 +4686,6 @@
4393
4686
  "update_settings": {
4394
4687
  "type": "object",
4395
4688
  "additionalProperties": {
4396
- "type": "object",
4397
4689
  "nullable": true
4398
4690
  },
4399
4691
  "description": "This is a schemaless object used to contain any required fields for updating carrier settings.",