@shipengine/connect-carrier-api 4.16.5 → 4.16.7

package/spec.json

@@ -3,14 +3,12 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.28.0"
+    "version": "1.28.4"
   },
   "paths": {
     "/Register": {
       "post": {
-        "tags": [
-          "Account Setup"
-        ],
+        "tags": ["Account Setup"],
         "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.",
         "operationId": "Register",
         "requestBody": {
@@ -20,7 +18,19 @@
               "schema": {
                 "$ref": "#/components/schemas/ExampleRegisterRequest"
               },
-              "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"}}
+              "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"
+                }
+              }
             }
           }
         },
@@ -32,7 +42,17 @@
                 "schema": {
                   "$ref": "#/components/schemas/RegisterResponse"
                 },
-                "example": {"credentials":{"username":"auctane-next-day","password":"password!"},"metadata":{"username":"auctane-next-day","password":"password!","meter_number":"8675309"}}
+                "example": {
+                  "credentials": {
+                    "username": "auctane-next-day",
+                    "password": "password!"
+                  },
+                  "metadata": {
+                    "username": "auctane-next-day",
+                    "password": "password!",
+                    "meter_number": "8675309"
+                  }
+                }
               }
             }
           }
@@ -41,9 +61,7 @@
     },
     "/CreateLabel": {
       "post": {
-        "tags": [
-          "Labels"
-        ],
+        "tags": ["Labels"],
         "description": "This method creates a new label.",
         "operationId": "CreateLabel",
         "parameters": [
@@ -83,9 +101,7 @@
     },
     "/VoidLabels": {
       "post": {
-        "tags": [
-          "Labels"
-        ],
+        "tags": ["Labels"],
         "description": "This method is used to void a previously created labels.",
         "operationId": "VoidLabels",
         "requestBody": {
@@ -114,9 +130,7 @@
     },
     "/CreateManifest": {
       "post": {
-        "tags": [
-          "Manifesting"
-        ],
+        "tags": ["Manifesting"],
         "description": "This method creates an end-of-day manifest and should be implemented by carrier apps that support\r\nend-of-day manifesting.",
         "operationId": "CreateManifest",
         "requestBody": {
@@ -145,9 +159,7 @@
     },
     "/GetManifest": {
       "post": {
-        "tags": [
-          "Manifesting"
-        ],
+        "tags": ["Manifesting"],
         "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.",
         "operationId": "GetManifest",
         "requestBody": {
@@ -176,9 +188,7 @@
     },
     "/ValidateInboundData": {
       "post": {
-        "tags": [
-          "Normalize Inbound Data"
-        ],
+        "tags": ["Normalize Inbound Data"],
         "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",
         "operationId": "ValidateInboundData",
         "requestBody": {
@@ -188,7 +198,22 @@
               "schema": {
                 "$ref": "#/components/schemas/ValidateInboundDataRequest"
               },
-              "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"}}
+              "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"
+                }
+              }
             }
           }
         },
@@ -203,7 +228,7 @@
                 "examples": {
                   "Tracking": {
                     "summary": "Tracking",
-                    "value": {"content_types":["tracking"]}
+                    "value": { "content_types": ["tracking"] }
                   }
                 }
               }
@@ -214,9 +239,7 @@
     },
     "/NormalizeTrackingData": {
       "post": {
-        "tags": [
-          "Normalize Inbound Data"
-        ],
+        "tags": ["Normalize Inbound Data"],
         "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",
         "operationId": "NormalizeTrackingData",
         "requestBody": {
@@ -226,7 +249,22 @@
               "schema": {
                 "$ref": "#/components/schemas/NormalizeTrackingDataRequest"
               },
-              "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"}}
+              "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"
+                }
+              }
             }
           }
         },
@@ -241,7 +279,25 @@
                 "examples": {
                   "Delivered": {
                     "summary": "Delivered",
-                    "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"}
+                    "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"
+                    }
                   }
                 }
               }
@@ -252,9 +308,7 @@
     },
     "/CreateNotification": {
       "post": {
-        "tags": [
-          "Shipment Notifications"
-        ],
+        "tags": ["Shipment Notifications"],
         "operationId": "CreateNotification",
         "requestBody": {
           "content": {
@@ -281,9 +335,7 @@
     },
     "/CancelNotification": {
       "post": {
-        "tags": [
-          "Shipment Notifications"
-        ],
+        "tags": ["Shipment Notifications"],
         "operationId": "CancelNotification",
         "requestBody": {
           "content": {
@@ -310,9 +362,7 @@
     },
     "/SchedulePickup": {
       "post": {
-        "tags": [
-          "Scheduled Pickups"
-        ],
+        "tags": ["Scheduled Pickups"],
         "description": "This method is used to schedule a pickup with a carrier.",
         "operationId": "SchedulePickup",
         "requestBody": {
@@ -341,9 +391,7 @@
     },
     "/CancelPickup": {
       "post": {
-        "tags": [
-          "Scheduled Pickups"
-        ],
+        "tags": ["Scheduled Pickups"],
         "operationId": "CancelPickup",
         "requestBody": {
           "content": {
@@ -368,11 +416,36 @@
         }
       }
     },
+    "/ListPickups": {
+      "post": {
+        "tags": ["List Pickups"],
+        "operationId": "ListPickups",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ListPickupsRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful list pickups request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ListPickupsResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/GetRates": {
       "post": {
-        "tags": [
-          "Rating"
-        ],
+        "tags": ["Rating"],
         "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.",
         "operationId": "GetRates",
         "requestBody": {
@@ -401,9 +474,7 @@
     },
     "/GetRelayPoints": {
       "post": {
-        "tags": [
-          "Relay Points"
-        ],
+        "tags": ["Relay Points"],
         "description": "This method gets carrier relay points based on search criteria.",
         "operationId": "GetRelayPoints",
         "parameters": [
@@ -443,9 +514,7 @@
     },
     "/GetServicePoints": {
       "post": {
-        "tags": [
-          "Service Points"
-        ],
+        "tags": ["Service Points"],
         "description": "This method gets carrier service points based on search criteria.",
         "operationId": "Get Service Points",
         "parameters": [
@@ -485,9 +554,7 @@
     },
     "/GetServicePoint": {
       "post": {
-        "tags": [
-          "Service Points"
-        ],
+        "tags": ["Service Points"],
         "description": "This method gets a carrier service point by id",
         "operationId": "Get Service Point",
         "parameters": [
@@ -527,9 +594,7 @@
     },
     "/Track": {
       "post": {
-        "tags": [
-          "Tracking"
-        ],
+        "tags": ["Tracking"],
         "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.",
         "operationId": "Track",
         "requestBody": {
@@ -539,7 +604,32 @@
               "schema": {
                 "$ref": "#/components/schemas/TrackingRequest"
               },
-              "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"}}
+              "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"
+                }
+              }
             }
           }
         },
@@ -554,15 +644,189 @@
                 "examples": {
                   "Delivered with Event History": {
                     "summary": "Delivered with Event History",
-                    "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}}
+                    "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
+                      }
+                    }
                   },
                   "Not Yet in System": {
                     "summary": "Not Yet in System",
-                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"NY","events":[],"shipping_problem":false,"carrierEnum":0}}
+                    "value": {
+                      "tracking_info": {
+                        "carrier_name": "UPS",
+                        "tracking_number": "12345678901234567890",
+                        "standardized_status_code": "NY",
+                        "events": [],
+                        "shipping_problem": false,
+                        "carrierEnum": 0
+                      }
+                    }
                   },
                   "Fatal Exception": {
                     "summary": "Fatal Exception",
-                    "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}}
+                    "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
+                      }
+                    }
                   }
                 }
               }
@@ -573,9 +837,7 @@
     },
     "/ImportTrackingEvents": {
       "post": {
-        "tags": [
-          "Tracking"
-        ],
+        "tags": ["Tracking"],
         "description": "This method should yield imported tracking events for a connection. It should\r\nonly be implemented if you support importing tracking data in bulk via file\r\nexchange or API requests.\r\nAny information needed to retrieve tracking data for a connection should be\r\ncollected in your registration form and will be made available as metadata in\r\nthe request.\r\nSee the [Tracking Overview](https://connect.shipengine.com/shipping/tracking/)\r\nfor implementation details.",
         "operationId": "ImportTrackingEvents",
         "requestBody": {
@@ -607,9 +869,7 @@
     },
     "/UpdateSettings": {
       "post": {
-        "tags": [
-          "Account Setup"
-        ],
+        "tags": ["Account Setup"],
         "description": "This method is used to update carrier settings.",
         "operationId": "Update Settings",
         "requestBody": {
@@ -638,9 +898,7 @@
     },
     "/ValidateShipment": {
       "post": {
-        "tags": [
-          "Validations"
-        ],
+        "tags": ["Validations"],
         "description": "This method validates a shipment against carrier constraints for selected service.",
         "operationId": "ValidateShipment",
         "requestBody": {
@@ -671,18 +929,12 @@
   "components": {
     "schemas": {
       "AccessibilityTypes": {
-        "enum": [
-          "accessible",
-          "inaccessible"
-        ],
+        "enum": ["accessible", "inaccessible"],
         "type": "string",
         "description": "Specifies if the product is accessible during delivery,\r\naccessible\r\ninaccessible"
       },
       "AddressBase": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "properties": {
           "address_lines": {
@@ -717,21 +969,12 @@
         "additionalProperties": false
       },
       "AddressResidentialIndicator": {
-        "enum": [
-          "unknown",
-          "yes",
-          "no",
-          "commercial",
-          "residential"
-        ],
+        "enum": ["unknown", "yes", "no", "commercial", "residential"],
         "type": "string",
         "description": "'Commercial' is no longer used, please use 'No'. <br />'Residential' is no longer used, please use 'Yes'."
       },
       "AddressWithContact": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -809,10 +1052,7 @@
             "description": "Describes whether or not the shipment is requested to be delivered on a Saturday."
           },
           "tip": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -869,7 +1109,7 @@
             "$ref": "#/components/schemas/TransportMeanEnum"
           }
         },
-        "additionalProperties": { },
+        "additionalProperties": {},
         "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."
       },
       "Authorization": {
@@ -893,9 +1133,7 @@
         "additionalProperties": false
       },
       "BaseRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "properties": {
           "transaction_id": {
@@ -935,10 +1173,7 @@
         "additionalProperties": false
       },
       "BillTo": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -959,11 +1194,7 @@
         "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."
       },
       "BillToParty": {
-        "enum": [
-          "shipper",
-          "recipient",
-          "third_party_account"
-        ],
+        "enum": ["shipper", "recipient", "third_party_account"],
         "type": "string",
         "description": "The type of party responsible for a given category of charges associated with a shipment, such as shipping charges or import duties."
       },
@@ -993,10 +1224,7 @@
         "type": "string"
       },
       "BillingLineItem": {
-        "required": [
-          "billing_category",
-          "amount"
-        ],
+        "required": ["billing_category", "amount"],
         "type": "object",
         "properties": {
           "billing_category": {
@@ -1018,10 +1246,7 @@
             "nullable": true
           },
           "amount": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1043,9 +1268,7 @@
         "additionalProperties": false
       },
       "CancelNotificationRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -1091,10 +1314,7 @@
         "description": "The response to the cancellation of a pending shipment notification."
       },
       "CancelPickupRequest": {
-        "required": [
-          "pickup_windows",
-          "transaction_id"
-        ],
+        "required": ["pickup_windows", "transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -1139,9 +1359,7 @@
         "description": "A request to cancel a previously scheduled pickup"
       },
       "CancelPickupResponse": {
-        "required": [
-          "successful"
-        ],
+        "required": ["successful"],
         "type": "object",
         "allOf": [
           {
@@ -1178,9 +1396,7 @@
         "description": "This model represents a response for a successful cancel pickup request."
       },
       "CancellationDetails": {
-        "required": [
-          "reason"
-        ],
+        "required": ["reason"],
         "type": "object",
         "properties": {
           "reason": {
@@ -1230,25 +1446,16 @@
         "additionalProperties": false
       },
       "CodPaymentType": {
-        "enum": [
-          "any",
-          "cash",
-          "guaranteed_funds"
-        ],
+        "enum": ["any", "cash", "guaranteed_funds"],
         "type": "string",
         "description": "Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment.\r\nany - Any payment method is permitted.\r\ncash - Only cash is permitted.\r\nguaranteed_funds - Only guaranteed funds are permitted, such as a money order or cashier's check."
       },
       "CollectOnDelivery": {
-        "required": [
-          "payment_amount"
-        ],
+        "required": ["payment_amount"],
         "type": "object",
         "properties": {
           "payment_amount": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1407,6 +1614,9 @@
             },
             "description": "Display schemes that the label will be returned in. Label is returned by default",
             "nullable": true
+          },
+          "dangerous_goods_declaration": {
+            "$ref": "#/components/schemas/DangerousGoodsDeclaration"
           }
         },
         "additionalProperties": false
@@ -1509,9 +1719,7 @@
         "description": "This model represents the response from a successful create label request."
       },
       "CreateManifestRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -1557,9 +1765,7 @@
         "description": "This model represents the request payload needed to manifest with a shipping provider."
       },
       "CreateManifestResponse": {
-        "required": [
-          "manifests"
-        ],
+        "required": ["manifests"],
         "type": "object",
         "allOf": [
           {
@@ -1622,9 +1828,7 @@
         "description": "This model represents the successful response for a create manifest request."
       },
       "CreateNotificationRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -1671,10 +1875,7 @@
         "description": "The response to a notification request."
       },
       "Credentials": {
-        "required": [
-          "username",
-          "password"
-        ],
+        "required": ["username", "password"],
         "type": "object",
         "properties": {
           "username": {
@@ -1693,10 +1894,7 @@
         "type": "object",
         "properties": {
           "freight_charge": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1712,10 +1910,7 @@
             "nullable": true
           },
           "other_charge": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1736,10 +1931,7 @@
             "nullable": true
           },
           "insurance_charge": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1755,10 +1947,7 @@
             "nullable": true
           },
           "discount": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1795,10 +1984,7 @@
             "$ref": "#/components/schemas/CustomsNonDelivery"
           },
           "buyer_shipping_amount_paid": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1814,10 +2000,7 @@
             "nullable": true
           },
           "duties_paid": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -1884,10 +2067,7 @@
         "type": "string"
       },
       "CustomsNonDelivery": {
-        "enum": [
-          "return_to_sender",
-          "treat_as_abandoned"
-        ],
+        "enum": ["return_to_sender", "treat_as_abandoned"],
         "type": "string",
         "description": "What to do if the shipment is undeliverable."
       },
@@ -2000,6 +2180,15 @@
           },
           "accessibility": {
             "$ref": "#/components/schemas/AccessibilityTypes"
+          },
+          "special_provisions": {
+            "type": "string",
+            "description": "A comma-separated list of special provisions that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements.",
+            "nullable": true,
+            "example": "A88, A183"
+          },
+          "inner_packaging": {
+            "$ref": "#/components/schemas/DangerousGoodsInnerPackaging"
           }
         },
         "additionalProperties": false,
@@ -2022,6 +2211,86 @@
         "additionalProperties": false,
         "description": "This model represents contact information regarding dangerous goods"
       },
+      "DangerousGoodsDeclaration": {
+        "type": "object",
+        "properties": {
+          "regulation_set": {
+            "type": "string",
+            "description": "Name of the regulatory authority",
+            "nullable": true
+          },
+          "emergency_contact": {
+            "$ref": "#/components/schemas/DangerousGoodsContact"
+          },
+          "signatory": {
+            "$ref": "#/components/schemas/Signatory"
+          },
+          "additional_handling_information": {
+            "type": "string",
+            "description": "Any supplementary instructions or special provisions related to the handling of the dangerous goods shipment, such as competent authority approvals or specific handling requirements.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "An object containing high-level information about the dangerous goods declaration for the entire shipment."
+      },
+      "DangerousGoodsInnerPackaging": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "The type of inner packaging used.",
+            "nullable": true
+          },
+          "quantity": {
+            "type": "number",
+            "description": "The number of individual inner packagings contained within the outer package for this specific dangerous good.",
+            "format": "double",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "An object detailing the inner packaging of the dangerous good."
+      },
+      "DangerousGoodsPackageInfo": {
+        "type": "object",
+        "properties": {
+          "transport_mean": {
+            "$ref": "#/components/schemas/TransportMeanEnum"
+          },
+          "accessibility": {
+            "type": "boolean",
+            "description": "Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. True if accessible, false otherwise.",
+            "nullable": true
+          },
+          "is_overpack": {
+            "type": "boolean",
+            "description": "Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. True if it is an overpack, false otherwise.",
+            "nullable": true
+          },
+          "all_packed_in_one": {
+            "type": "boolean",
+            "description": "Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise.",
+            "nullable": true
+          },
+          "q_value": {
+            "type": "number",
+            "description": "The \"Q\" value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable.",
+            "format": "double",
+            "nullable": true
+          },
+          "outer_packaging_type": {
+            "type": "string",
+            "description": "The type of outer packaging used for the dangerous goods package, typically represented by a UN packaging code.",
+            "nullable": true
+          },
+          "regulation_level": {
+            "$ref": "#/components/schemas/RegulationLevelEnum"
+          }
+        },
+        "additionalProperties": false,
+        "description": "An object containing information specific to the dangerous goods aspects of an individual package."
+      },
       "DayOfOperation": {
         "type": "object",
         "properties": {
@@ -2060,10 +2329,7 @@
         "description": "This model represents the dimensions for a package represented in its original unit, inches, and centimeters."
       },
       "DimensionUnit": {
-        "enum": [
-          "inches",
-          "centimeters"
-        ],
+        "enum": ["inches", "centimeters"],
         "type": "string",
         "description": "This model represents the supported units for dimensions."
       },
@@ -2093,18 +2359,11 @@
         "description": "This model represents the measurements for dimensions."
       },
       "DisplayScheme": {
-        "enum": [
-          "label",
-          "paperless_label"
-        ],
+        "enum": ["label", "paperless_label"],
         "type": "string"
       },
       "Document": {
-        "required": [
-          "type",
-          "data",
-          "format"
-        ],
+        "required": ["type", "data", "format"],
         "type": "object",
         "properties": {
           "type": {
@@ -2128,11 +2387,7 @@
         "description": "Container for a document."
       },
       "DocumentFormat": {
-        "enum": [
-          "PDF",
-          "ZPL",
-          "PNG"
-        ],
+        "enum": ["PDF", "ZPL", "PNG"],
         "type": "string"
       },
       "DocumentType": {
@@ -2149,10 +2404,7 @@
         "type": "object",
         "properties": {
           "taxes": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -2168,10 +2420,7 @@
             "nullable": true
           },
           "duties": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -2278,16 +2527,12 @@
         "description": "Geolocation additional information for an address."
       },
       "GeolocationType": {
-        "enum": [
-          "what3words"
-        ],
+        "enum": ["what3words"],
         "type": "string",
         "description": "Specifies the supported geolocation types."
       },
       "GetManifestRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -2420,6 +2665,9 @@
             },
             "description": "Display schemes in which the rate will be evaluated. Labels are used by default.",
             "nullable": true
+          },
+          "dangerous_goods_declaration": {
+            "$ref": "#/components/schemas/DangerousGoodsDeclaration"
           }
         },
         "additionalProperties": false,
@@ -2484,9 +2732,7 @@
         "description": "This model represents the payload sent to get relay points based on the provided search criteria."
       },
       "GetRelayPointsResponse": {
-        "required": [
-          "relay_points"
-        ],
+        "required": ["relay_points"],
         "type": "object",
         "properties": {
           "relay_points": {
@@ -2501,9 +2747,7 @@
         "description": "Basic structure for a response to get relay points"
       },
       "GetServicePointRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -2539,9 +2783,7 @@
         "additionalProperties": false
       },
       "GetServicePointsRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -2609,10 +2851,7 @@
         "additionalProperties": false
       },
       "Identifier": {
-        "required": [
-          "type",
-          "value"
-        ],
+        "required": ["type", "value"],
         "type": "object",
         "properties": {
           "type": {
@@ -2630,9 +2869,7 @@
         "description": "A key value pair, allowing custom properties to be stored."
       },
       "ImportTrackingEventsRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -2736,9 +2973,7 @@
         "description": "Basic structure for a Importer Record"
       },
       "InboundDataContentTypes": {
-        "enum": [
-          "tracking"
-        ],
+        "enum": ["tracking"],
         "type": "string"
       },
       "InsuranceProviders": {
@@ -2763,12 +2998,7 @@
         "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."
       },
       "LabelLayouts": {
-        "enum": [
-          "4x6",
-          "letter",
-          "A4",
-          "A6"
-        ],
+        "enum": ["4x6", "letter", "A4", "A6"],
         "type": "string"
       },
       "LabelMessage": {
@@ -2878,10 +3108,7 @@
             "$ref": "#/components/schemas/CustomsNonDelivery"
           },
           "buyer_shipping_amount_paid": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -2897,10 +3124,7 @@
             "nullable": true
           },
           "duties_paid": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -2983,11 +3207,6 @@
             "description": "Shipment ship date time.",
             "format": "date-time"
           },
-          "reference": {
-            "type": "string",
-            "description": "Shipment reference number.",
-            "nullable": true
-          },
           "customs": {
             "$ref": "#/components/schemas/ManifestCustoms"
           }
@@ -2995,27 +3214,15 @@
         "additionalProperties": false
       },
       "ManifestStatus": {
-        "enum": [
-          "unknown",
-          "in_progress",
-          "completed",
-          "failed"
-        ],
+        "enum": ["unknown", "in_progress", "completed", "failed"],
         "type": "string"
       },
       "MovementIndicator": {
-        "enum": [
-          "b2c",
-          "b2b",
-          "c2c",
-          "c2b"
-        ],
+        "enum": ["b2c", "b2b", "c2c", "c2b"],
         "type": "string"
       },
       "NormalizeTrackingDataRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -3112,9 +3319,7 @@
         "description": "The times each day that the relay point is open, for example: \"11:00-13:00, 14:30-19:30\""
       },
       "Package": {
-        "required": [
-          "insured_value"
-        ],
+        "required": ["insured_value"],
         "type": "object",
         "properties": {
           "package_code": {
@@ -3134,10 +3339,7 @@
             "$ref": "#/components/schemas/WeightDetails"
           },
           "insured_value": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -3162,26 +3364,20 @@
             },
             "description": "List of products associated with this package.",
             "nullable": true
+          },
+          "dangerous_goods_package_info": {
+            "$ref": "#/components/schemas/DangerousGoodsPackageInfo"
           }
         },
         "additionalProperties": false,
         "description": "This model represents an individual package that is part of a shipment."
       },
       "PackageInstructionSectionEnum": {
-        "enum": [
-          "section_1",
-          "section_2",
-          "section_1A",
-          "section_1B"
-        ],
+        "enum": ["section_1", "section_2", "section_1A", "section_1B"],
         "type": "string"
       },
       "PackagingGroupEnum": {
-        "enum": [
-          "i",
-          "ii",
-          "iii"
-        ],
+        "enum": ["i", "ii", "iii"],
         "type": "string"
       },
       "PaperlessDetails": {
@@ -3228,11 +3424,7 @@
         "description": "This model contains the confirmation information for a scheduled pickup."
       },
       "PickupContactDetails": {
-        "required": [
-          "first_name",
-          "email",
-          "phone_number"
-        ],
+        "required": ["first_name", "email", "phone_number"],
         "type": "object",
         "properties": {
           "first_name": {
@@ -3310,12 +3502,7 @@
         "description": "Contains information regarding the service code for the pickup request and the packages that will be picked up"
       },
       "PickupWindow": {
-        "required": [
-          "time_zone_iana",
-          "pickup_date",
-          "start_time",
-          "end_time"
-        ],
+        "required": ["time_zone_iana", "pickup_date", "start_time", "end_time"],
         "type": "object",
         "properties": {
           "time_zone_iana": {
@@ -3349,9 +3536,7 @@
         "description": "This model represents a window of time a pickup could be made."
       },
       "Products": {
-        "required": [
-          "value"
-        ],
+        "required": ["value"],
         "type": "object",
         "properties": {
           "description": {
@@ -3365,10 +3550,7 @@
             "format": "int32"
           },
           "value": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -3434,14 +3616,11 @@
             "nullable": true
           }
         },
-        "additionalProperties": { },
+        "additionalProperties": {},
         "description": "This model represents the product information for a single item."
       },
       "PudoLocation": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -3551,9 +3730,7 @@
         "description": "This model represents a rate for a given service code."
       },
       "RawExternalSource": {
-        "required": [
-          "marketplace_code"
-        ],
+        "required": ["marketplace_code"],
         "type": "object",
         "properties": {
           "marketplace_code": {
@@ -3566,10 +3743,7 @@
         "description": "This model represents a raw external source of information."
       },
       "RegisterRequest": {
-        "required": [
-          "registration_info",
-          "transaction_id"
-        ],
+        "required": ["registration_info", "transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -3591,10 +3765,7 @@
         "description": "This model represents the body of a request used to register a new user within ShipEngine."
       },
       "RegisterResponse": {
-        "required": [
-          "credentials",
-          "metadata"
-        ],
+        "required": ["credentials", "metadata"],
         "type": "object",
         "properties": {
           "credentials": {
@@ -3707,10 +3878,7 @@
         "description": "The address information corresponding to a specific relay point"
       },
       "RelayPointDetails": {
-        "required": [
-          "ship_to",
-          "ship_from"
-        ],
+        "required": ["ship_to", "ship_from"],
         "type": "object",
         "properties": {
           "ship_to": {
@@ -3741,9 +3909,7 @@
         "description": "Used for generic downloads, containing the resource itself or a link to where it can be found"
       },
       "ReturnLabelDetails": {
-        "required": [
-          "rma_number"
-        ],
+        "required": ["rma_number"],
         "type": "object",
         "properties": {
           "rma_number": {
@@ -3755,11 +3921,76 @@
         "additionalProperties": false,
         "description": "Return Label Information (Added 1.13)"
       },
-      "SchedulePickupRequest": {
-        "required": [
-          "requested_pickup_window",
-          "transaction_id"
+      "ListPickupsRequest": {
+        "required": [],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseRequest"
+          }
+        ],
+        "properties": {
+          "address": {
+            "$ref": "#/components/schemas/PickupAddress"
+          },
+          "search_window": {
+            "$ref": "#/components/schemas/TimeWindow"
+          }
+        },
+        "additionalProperties": false,
+        "description": "A request to list pickups scheduled with a carrier"
+      },
+      "ListPickupsResponse": {
+        "required": ["pickups"],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseResponse"
+          }
+        ],
+        "properties": {
+          "pickupspickup_windows": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Pickup"
+            },
+            "description": "A list of scheduled pickups and their statuses",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "The response for listing scheduled pickups."
+      },
+      "Pickup": {
+        "type": "object",
+        "properties": {
+          "confirmation_number": {
+            "type": "string",
+            "description": "The original confirmation number returned when scheduling the pickup."
+          },
+          "status": {
+            "type": "string",
+            "description": "The status of the scheduled pickup."
+          },
+          "status_description": {
+            "type": "string",
+            "description": "A description of the status of the scheduled pickup.",
+            "nullable": true
+          }
+        }
+      },
+      "PickupAddress": {
+        "required": ["postal_code", "country_code"],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AddressBase"
+          }
         ],
+        "additionalProperties": false
+      },
+      "SchedulePickupRequest": {
+        "required": ["requested_pickup_window", "transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -3784,9 +4015,7 @@
         "description": "A request to schedule a pickup with a carrier"
       },
       "SchedulePickupResponse": {
-        "required": [
-          "pickup_windows"
-        ],
+        "required": ["pickup_windows"],
         "type": "object",
         "allOf": [
           {
@@ -3859,10 +4088,7 @@
         "additionalProperties": false
       },
       "SearchRadiusUnit": {
-        "enum": [
-          "miles",
-          "kilometers"
-        ],
+        "enum": ["miles", "kilometers"],
         "type": "string"
       },
       "Service": {
@@ -3923,10 +4149,7 @@
         "additionalProperties": false
       },
       "ServicePointAddress": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -3951,17 +4174,11 @@
         "type": "string"
       },
       "ServicePointLocationType": {
-        "enum": [
-          "pudo",
-          "locker"
-        ],
+        "enum": ["pudo", "locker"],
         "type": "string"
       },
       "ServicePointResponseAddress": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -4005,10 +4222,7 @@
         "additionalProperties": false
       },
       "ShipFrom": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -4029,10 +4243,7 @@
         "description": "The shipment sender's address. It may or may not have been validated."
       },
       "ShipFromDisplay": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -4043,10 +4254,7 @@
         "description": "The address that should be displayed as the return address, only if the shipping provider supports\r\nthis functionality."
       },
       "ShipTo": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
+        "required": ["postal_code", "country_code"],
         "type": "object",
         "allOf": [
           {
@@ -4141,10 +4349,7 @@
             "$ref": "#/components/schemas/Customs"
           },
           "insured_value": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -4172,9 +4377,7 @@
         "description": "This is the model for a package that has had a label generated for it"
       },
       "ShippedProducts": {
-        "required": [
-          "value"
-        ],
+        "required": ["value"],
         "type": "object",
         "properties": {
           "description": {
@@ -4188,10 +4391,7 @@
             "format": "int32"
           },
           "value": {
-            "required": [
-              "currency",
-              "amount"
-            ],
+            "required": ["currency", "amount"],
             "type": "object",
             "properties": {
               "amount": {
@@ -4254,7 +4454,7 @@
             "nullable": true
           }
         },
-        "additionalProperties": { },
+        "additionalProperties": {},
         "description": "This model represents the product of a package that has had a label generated for it"
       },
       "ShippedShipment": {
@@ -4297,6 +4497,11 @@
           },
           "dropoff_location": {
             "$ref": "#/components/schemas/PudoLocation"
+          },
+          "reference": {
+            "type": "string",
+            "description": "User specified free form string to identify shipment in their own system",
+            "nullable": true
           }
         },
         "additionalProperties": false,
@@ -4351,16 +4556,7 @@
         "additionalProperties": false
       },
       "StandardizedStatusCodes": {
-        "enum": [
-          "UN",
-          "AC",
-          "IT",
-          "DE",
-          "EX",
-          "AT",
-          "NY",
-          "SP"
-        ],
+        "enum": ["UN", "AC", "IT", "DE", "EX", "AT", "NY", "SP"],
         "type": "string",
         "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"
       },
@@ -4513,9 +4709,7 @@
         "description": "Entity representing a Tax Identification number, type, and country of registration."
       },
       "TaxType": {
-        "enum": [
-          "vat"
-        ],
+        "enum": ["vat"],
         "type": "string"
       },
       "TermsOfTradeCode": {
@@ -4642,10 +4836,7 @@
         "description": "This model represents a tracking event for a shipment."
       },
       "TrackingAttribute": {
-        "required": [
-          "type",
-          "value"
-        ],
+        "required": ["type", "value"],
         "type": "object",
         "properties": {
           "type": {
@@ -4783,9 +4974,7 @@
         "description": "This model represents tracking information for a shipment."
       },
       "TrackingRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -4814,9 +5003,7 @@
         "description": "This model represents the payload that is sent to request tracking information."
       },
       "TrackingResponse": {
-        "required": [
-          "tracking_info"
-        ],
+        "required": ["tracking_info"],
         "type": "object",
         "allOf": [
           {
@@ -4886,17 +5073,11 @@
         "type": "string"
       },
       "UpdateMethods": {
-        "enum": [
-          "append",
-          "replace"
-        ],
+        "enum": ["append", "replace"],
         "type": "string"
       },
       "UpdateSettingsRequest": {
-        "required": [
-          "update_settings",
-          "transaction_id"
-        ],
+        "required": ["update_settings", "transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -4928,9 +5109,7 @@
         "description": "This model represents the successful response for updating carrier settings request."
       },
       "ValidateInboundDataRequest": {
-        "required": [
-          "transaction_id"
-        ],
+        "required": ["transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -5059,10 +5238,7 @@
         "description": "A list of standard validation error identifiers for errors the module can return"
       },
       "VoidLabelsRequest": {
-        "required": [
-          "void_requests",
-          "transaction_id"
-        ],
+        "required": ["void_requests", "transaction_id"],
         "type": "object",
         "allOf": [
           {
@@ -5083,9 +5259,7 @@
         "description": "This model represents the payload sent to void a set of labels."
       },
       "VoidLabelsResponse": {
-        "required": [
-          "void_responses"
-        ],
+        "required": ["void_responses"],
         "type": "object",
         "allOf": [
           {
@@ -5106,10 +5280,7 @@
         "description": "This model represents the successful attempt to void a set of labels."
       },
       "VoidRequest": {
-        "required": [
-          "void_request_id",
-          "ship_from"
-        ],
+        "required": ["void_request_id", "ship_from"],
         "type": "object",
         "allOf": [
           {
@@ -5124,20 +5295,13 @@
           },
           "ship_from": {
             "$ref": "#/components/schemas/ShipFrom"
-          },
-          "reference": {
-            "type": "string",
-            "description": "A user specified free form string to identify this shipment in their own system.\r\nMight be used instead of tracking number/alternative_identifiers\r\nAdded in 1.25.2",
-            "nullable": true
           }
         },
         "additionalProperties": false,
         "description": "A request to void a particular label."
       },
       "VoidResponse": {
-        "required": [
-          "void_request_id"
-        ],
+        "required": ["void_request_id"],
         "type": "object",
         "properties": {
           "void_request_id": {
@@ -5251,12 +5415,7 @@
         "description": "This model represents the weight of a package in its original unit, ounces, and grams."
       },
       "WeightUnit": {
-        "enum": [
-          "grams",
-          "ounces",
-          "kilograms",
-          "pounds"
-        ],
+        "enum": ["grams", "ounces", "kilograms", "pounds"],
         "type": "string",
         "description": "This model describes the possible units of weight."
       },
@@ -5322,4 +5481,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}