@shipengine/connect-carrier-api 4.16.10 → 4.17.0-beta

package/spec.json

@@ -3,12 +3,14 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.28.5"
+    "version": "1.29.0"
   },
   "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": {
@@ -61,7 +63,9 @@
     },
     "/CreateLabel": {
       "post": {
-        "tags": ["Labels"],
+        "tags": [
+          "Labels"
+        ],
         "description": "This method creates a new label.",
         "operationId": "CreateLabel",
         "parameters": [
@@ -101,7 +105,9 @@
     },
     "/VoidLabels": {
       "post": {
-        "tags": ["Labels"],
+        "tags": [
+          "Labels"
+        ],
         "description": "This method is used to void a previously created labels.",
         "operationId": "VoidLabels",
         "requestBody": {
@@ -130,7 +136,9 @@
     },
     "/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": {
@@ -159,7 +167,9 @@
     },
     "/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": {
@@ -188,7 +198,9 @@
     },
     "/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": {
@@ -201,7 +213,9 @@
               "example": {
                 "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
                 "headers": {
-                  "content-type": ["application/json"],
+                  "content-type": [
+                    "application/json"
+                  ],
                   "X-Signature": [
                     "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
                     "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
@@ -228,7 +242,11 @@
                 "examples": {
                   "Tracking": {
                     "summary": "Tracking",
-                    "value": { "content_types": ["tracking"] }
+                    "value": {
+                      "content_types": [
+                        "tracking"
+                      ]
+                    }
                   }
                 }
               }
@@ -239,7 +257,9 @@
     },
     "/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": {
@@ -252,7 +272,9 @@
               "example": {
                 "data": "{\"tracking_number\":\"12345678901234567890\",\"status\":11,\"timestamp\":\"2021-08-11T21:15:00Z\"}",
                 "headers": {
-                  "content-type": ["application/json"],
+                  "content-type": [
+                    "application/json"
+                  ],
                   "X-Signature": [
                     "v1:cedff7d0389299089e4c62c1042ce93059664d455ed0bfdf29cb959a861bda4b",
                     "v2:4b3157c730e498cb1126359fa020017e9e7c97b148f2d55da822fdfcd83e4a19"
@@ -289,7 +311,10 @@
                           "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" },
+                          "service": {
+                            "code": "03",
+                            "name": "UPS® Ground"
+                          },
                           "packaging": "package",
                           "package_count": 1,
                           "shipping_problem": false,
@@ -308,7 +333,9 @@
     },
     "/CreateNotification": {
       "post": {
-        "tags": ["Shipment Notifications"],
+        "tags": [
+          "Shipment Notifications"
+        ],
         "operationId": "CreateNotification",
         "requestBody": {
           "content": {
@@ -335,7 +362,9 @@
     },
     "/CancelNotification": {
       "post": {
-        "tags": ["Shipment Notifications"],
+        "tags": [
+          "Shipment Notifications"
+        ],
         "operationId": "CancelNotification",
         "requestBody": {
           "content": {
@@ -362,7 +391,9 @@
     },
     "/SchedulePickup": {
       "post": {
-        "tags": ["Scheduled Pickups"],
+        "tags": [
+          "Scheduled Pickups"
+        ],
         "description": "This method is used to schedule a pickup with a carrier.",
         "operationId": "SchedulePickup",
         "requestBody": {
@@ -391,7 +422,9 @@
     },
     "/CancelPickup": {
       "post": {
-        "tags": ["Scheduled Pickups"],
+        "tags": [
+          "Scheduled Pickups"
+        ],
         "operationId": "CancelPickup",
         "requestBody": {
           "content": {
@@ -418,7 +451,9 @@
     },
     "/ListPickups": {
       "post": {
-        "tags": ["List Pickups"],
+        "tags": [
+          "Scheduled Pickups"
+        ],
         "operationId": "ListPickups",
         "requestBody": {
           "content": {
@@ -445,7 +480,9 @@
     },
     "/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": {
@@ -474,7 +511,9 @@
     },
     "/GetRelayPoints": {
       "post": {
-        "tags": ["Relay Points"],
+        "tags": [
+          "Relay Points"
+        ],
         "description": "This method gets carrier relay points based on search criteria.",
         "operationId": "GetRelayPoints",
         "parameters": [
@@ -514,7 +553,9 @@
     },
     "/GetServicePoints": {
       "post": {
-        "tags": ["Service Points"],
+        "tags": [
+          "Service Points"
+        ],
         "description": "This method gets carrier service points based on search criteria.",
         "operationId": "Get Service Points",
         "parameters": [
@@ -554,7 +595,9 @@
     },
     "/GetServicePoint": {
       "post": {
-        "tags": ["Service Points"],
+        "tags": [
+          "Service Points"
+        ],
         "description": "This method gets a carrier service point by id",
         "operationId": "Get Service Point",
         "parameters": [
@@ -594,7 +637,9 @@
     },
     "/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": {
@@ -660,7 +705,10 @@
                           "width": 10.0,
                           "height": 10.0
                         },
-                        "service": { "code": "03", "name": "UPS® Ground" },
+                        "service": {
+                          "code": "03",
+                          "name": "UPS® Ground"
+                        },
                         "packaging": "package",
                         "package_count": 1,
                         "events": [
@@ -674,7 +722,10 @@
                             "state": "TX",
                             "postal_code": "78756",
                             "country": "US",
-                            "geo": { "lat": 30.31, "long": -97.74 },
+                            "geo": {
+                              "lat": 30.31,
+                              "long": -97.74
+                            },
                             "status_code": "AC"
                           },
                           {
@@ -687,7 +738,10 @@
                             "state": "TX",
                             "postal_code": "78756",
                             "country": "US",
-                            "geo": { "lat": 30.2, "long": -97.66 },
+                            "geo": {
+                              "lat": 30.2,
+                              "long": -97.66
+                            },
                             "status_code": "IT"
                           },
                           {
@@ -700,7 +754,10 @@
                             "state": "CA",
                             "postal_code": "90045",
                             "country": "US",
-                            "geo": { "lat": 33.95, "long": -118.38 },
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
                             "status_code": "IT"
                           },
                           {
@@ -713,7 +770,10 @@
                             "state": "CA",
                             "postal_code": "90045",
                             "country": "US",
-                            "geo": { "lat": 33.95, "long": -118.38 },
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
                             "status_code": "IT"
                           },
                           {
@@ -726,7 +786,10 @@
                             "state": "CA",
                             "postal_code": "90245",
                             "country": "US",
-                            "geo": { "lat": 33.95, "long": -118.38 },
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
                             "status_code": "AT"
                           },
                           {
@@ -739,7 +802,10 @@
                             "state": "CA",
                             "postal_code": "90045",
                             "country": "US",
-                            "geo": { "lat": 33.95, "long": -118.38 },
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
                             "status_code": "IT"
                           },
                           {
@@ -752,7 +818,10 @@
                             "state": "CA",
                             "postal_code": "90245",
                             "country": "US",
-                            "geo": { "lat": 33.95, "long": -118.38 },
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
                             "status_code": "DE"
                           }
                         ],
@@ -792,7 +861,10 @@
                           "width": 10.0,
                           "height": 10.0
                         },
-                        "service": { "code": "03", "name": "UPS® Ground" },
+                        "service": {
+                          "code": "03",
+                          "name": "UPS® Ground"
+                        },
                         "packaging": "package",
                         "package_count": 1,
                         "events": [
@@ -806,7 +878,10 @@
                             "state": "TX",
                             "postal_code": "78756",
                             "country": "US",
-                            "geo": { "lat": 30.2, "long": -97.66 },
+                            "geo": {
+                              "lat": 30.2,
+                              "long": -97.66
+                            },
                             "status_code": "IT"
                           },
                           {
@@ -819,7 +894,10 @@
                             "state": "CA",
                             "postal_code": "90245",
                             "country": "US",
-                            "geo": { "lat": 33.95, "long": -118.38 },
+                            "geo": {
+                              "lat": 33.95,
+                              "long": -118.38
+                            },
                             "status_code": "EX"
                           }
                         ],
@@ -837,7 +915,9 @@
     },
     "/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": {
@@ -869,7 +949,9 @@
     },
     "/UpdateSettings": {
       "post": {
-        "tags": ["Account Setup"],
+        "tags": [
+          "Account Setup"
+        ],
         "description": "This method is used to update carrier settings.",
         "operationId": "Update Settings",
         "requestBody": {
@@ -898,7 +980,9 @@
     },
     "/ValidateShipment": {
       "post": {
-        "tags": ["Validations"],
+        "tags": [
+          "Validations"
+        ],
         "description": "This method validates a shipment against carrier constraints for selected service.",
         "operationId": "ValidateShipment",
         "requestBody": {
@@ -929,12 +1013,18 @@
   "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": {
@@ -969,12 +1059,21 @@
         "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": [
           {
@@ -1052,7 +1151,10 @@
             "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": {
@@ -1133,7 +1235,9 @@
         "additionalProperties": false
       },
       "BaseRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "properties": {
           "transaction_id": {
@@ -1165,7 +1269,10 @@
         "properties": {
           "metadata": {
             "type": "object",
-            "additionalProperties": true,
+            "additionalProperties": {
+              "type": "object",
+              "nullable": true
+            },
             "description": "This is an optional schemaless object that you may return with a successful response. Anything returned\r\nunder this key will be included in all future requests. For example, you may store additional static\r\nproperties about the end user or their connection to the carrier. The maximum storage size\r\nfor data under this key is 4KB.",
             "nullable": true
           }
@@ -1173,7 +1280,10 @@
         "additionalProperties": false
       },
       "BillTo": {
-        "required": ["postal_code", "country_code"],
+        "required": [
+          "postal_code",
+          "country_code"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -1194,7 +1304,11 @@
         "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."
       },
@@ -1224,7 +1338,10 @@
         "type": "string"
       },
       "BillingLineItem": {
-        "required": ["billing_category", "amount"],
+        "required": [
+          "billing_category",
+          "amount"
+        ],
         "type": "object",
         "properties": {
           "billing_category": {
@@ -1246,7 +1363,10 @@
             "nullable": true
           },
           "amount": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -1268,7 +1388,9 @@
         "additionalProperties": false
       },
       "CancelNotificationRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -1314,7 +1436,10 @@
         "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": [
           {
@@ -1359,7 +1484,9 @@
         "description": "A request to cancel a previously scheduled pickup"
       },
       "CancelPickupResponse": {
-        "required": ["successful"],
+        "required": [
+          "successful"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -1396,7 +1523,9 @@
         "description": "This model represents a response for a successful cancel pickup request."
       },
       "CancellationDetails": {
-        "required": ["reason"],
+        "required": [
+          "reason"
+        ],
         "type": "object",
         "properties": {
           "reason": {
@@ -1446,16 +1575,25 @@
         "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": {
@@ -1681,6 +1819,14 @@
             "description": "Alternative identifiers associated with this shipment.",
             "nullable": true
           },
+          "limit_identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/LimitIdentifier"
+            },
+            "description": "An array that defines rate/usage limit identifiers applicable to specific functionalities within the integration. Each entry represents a unique limit configuration tied to a functionality (e.g., \"track,\" \"createLabel\").",
+            "nullable": true
+          },
           "estimated_delivery_datetime": {
             "type": "string",
             "description": "The estimated date and time for when the shipment will be delivered. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec.",
@@ -1719,7 +1865,9 @@
         "description": "This model represents the response from a successful create label request."
       },
       "CreateManifestRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -1765,7 +1913,9 @@
         "description": "This model represents the request payload needed to manifest with a shipping provider."
       },
       "CreateManifestResponse": {
-        "required": ["manifests"],
+        "required": [
+          "manifests"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -1828,7 +1978,9 @@
         "description": "This model represents the successful response for a create manifest request."
       },
       "CreateNotificationRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -1875,7 +2027,10 @@
         "description": "The response to a notification request."
       },
       "Credentials": {
-        "required": ["username", "password"],
+        "required": [
+          "username",
+          "password"
+        ],
         "type": "object",
         "properties": {
           "username": {
@@ -1894,7 +2049,10 @@
         "type": "object",
         "properties": {
           "freight_charge": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -1910,7 +2068,10 @@
             "nullable": true
           },
           "other_charge": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -1931,7 +2092,10 @@
             "nullable": true
           },
           "insurance_charge": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -1947,7 +2111,10 @@
             "nullable": true
           },
           "discount": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -1984,7 +2151,10 @@
             "$ref": "#/components/schemas/CustomsNonDelivery"
           },
           "buyer_shipping_amount_paid": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -2000,7 +2170,10 @@
             "nullable": true
           },
           "duties_paid": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -2067,7 +2240,10 @@
         "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."
       },
@@ -2329,7 +2505,10 @@
         "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."
       },
@@ -2359,11 +2538,18 @@
         "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": {
@@ -2387,7 +2573,11 @@
         "description": "Container for a document."
       },
       "DocumentFormat": {
-        "enum": ["PDF", "ZPL", "PNG"],
+        "enum": [
+          "PDF",
+          "ZPL",
+          "PNG"
+        ],
         "type": "string"
       },
       "DocumentType": {
@@ -2404,7 +2594,10 @@
         "type": "object",
         "properties": {
           "taxes": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -2420,7 +2613,10 @@
             "nullable": true
           },
           "duties": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -2527,12 +2723,16 @@
         "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": [
           {
@@ -2639,6 +2839,9 @@
           "pickup_location": {
             "$ref": "#/components/schemas/PudoLocation"
           },
+          "dropoff_location": {
+            "$ref": "#/components/schemas/PudoLocation"
+          },
           "international": {
             "type": "boolean",
             "description": "Whether this shipment is deemed international.",
@@ -2732,7 +2935,9 @@
         "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": {
@@ -2747,7 +2952,9 @@
         "description": "Basic structure for a response to get relay points"
       },
       "GetServicePointRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -2783,7 +2990,9 @@
         "additionalProperties": false
       },
       "GetServicePointsRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -2851,7 +3060,10 @@
         "additionalProperties": false
       },
       "Identifier": {
-        "required": ["type", "value"],
+        "required": [
+          "type",
+          "value"
+        ],
         "type": "object",
         "properties": {
           "type": {
@@ -2868,8 +3080,33 @@
         "additionalProperties": false,
         "description": "A key value pair, allowing custom properties to be stored."
       },
+      "LimitIdentifier": {
+        "required": [
+          "type",
+          "value"
+        ],
+        "type": "object",
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/LimitIdentifierType"
+          },
+          "value": {
+            "type": "string",
+            "description": "A unique identifier referencing the specific rate/usage limit configuration in the Rate Limiter."
+          }
+        }
+      },
+      "LimitIdentifierType": {
+        "type": "string",
+        "description": "The name of the functionality associated with this limit (e.g., \"track\").",
+        "enum": [
+          "track"
+        ]
+      },
       "ImportTrackingEventsRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -2973,7 +3210,9 @@
         "description": "Basic structure for a Importer Record"
       },
       "InboundDataContentTypes": {
-        "enum": ["tracking"],
+        "enum": [
+          "tracking"
+        ],
         "type": "string"
       },
       "InsuranceProviders": {
@@ -2998,7 +3237,12 @@
         "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": {
@@ -3074,6 +3318,40 @@
         "additionalProperties": false,
         "description": "This model represents a geographic point."
       },
+      "ListPickupsRequest": {
+        "required": [
+          "transaction_id"
+        ],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseRequest"
+          }
+        ],
+        "properties": {
+          "pickup_address": {
+            "$ref": "#/components/schemas/ShipFrom"
+          },
+          "search_window": {
+            "$ref": "#/components/schemas/TimeWindow"
+          }
+        },
+        "additionalProperties": false
+      },
+      "ListPickupsResponse": {
+        "type": "object",
+        "properties": {
+          "pickups": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Pickup"
+            },
+            "description": "List of scheduled pickups",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "Manifest": {
         "type": "object",
         "properties": {
@@ -3108,7 +3386,10 @@
             "$ref": "#/components/schemas/CustomsNonDelivery"
           },
           "buyer_shipping_amount_paid": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -3124,7 +3405,10 @@
             "nullable": true
           },
           "duties_paid": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -3214,15 +3498,27 @@
         "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": [
           {
@@ -3319,7 +3615,9 @@
         "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": {
@@ -3339,7 +3637,10 @@
             "$ref": "#/components/schemas/WeightDetails"
           },
           "insured_value": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -3373,11 +3674,20 @@
         "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": {
@@ -3395,6 +3705,27 @@
         "additionalProperties": false,
         "description": "The Paperless details for the shipment. This consists of additional information for paperless labels."
       },
+      "Pickup": {
+        "type": "object",
+        "properties": {
+          "confirmation_number": {
+            "type": "string",
+            "description": "Original confirmation number/ID of the scheduled pickup",
+            "nullable": true
+          },
+          "status": {
+            "type": "string",
+            "description": "Status of the pickup",
+            "nullable": true
+          },
+          "status_reason": {
+            "type": "string",
+            "description": "Description of/reason for the status",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "PickupConfirmation": {
         "type": "object",
         "properties": {
@@ -3424,7 +3755,11 @@
         "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": {
@@ -3481,6 +3816,25 @@
         "additionalProperties": false,
         "description": "This model represents the place where the pickup should occur"
       },
+      "PickupShipment": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ShippedShipment"
+          }
+        ],
+        "properties": {
+          "display_schemes": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DisplayScheme"
+            },
+            "description": "Label display scheme.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "PickupShipmentDetails": {
         "type": "object",
         "properties": {
@@ -3492,7 +3846,7 @@
           "shipments": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ShippedShipment"
+              "$ref": "#/components/schemas/PickupShipment"
             },
             "description": "The shipments that will be picked up",
             "nullable": true
@@ -3502,7 +3856,12 @@
         "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": {
@@ -3536,7 +3895,9 @@
         "description": "This model represents a window of time a pickup could be made."
       },
       "Products": {
-        "required": ["value"],
+        "required": [
+          "value"
+        ],
         "type": "object",
         "properties": {
           "description": {
@@ -3550,7 +3911,10 @@
             "format": "int32"
           },
           "value": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -3620,7 +3984,10 @@
         "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": [
           {
@@ -3730,7 +4097,9 @@
         "description": "This model represents a rate for a given service code."
       },
       "RawExternalSource": {
-        "required": ["marketplace_code"],
+        "required": [
+          "marketplace_code"
+        ],
         "type": "object",
         "properties": {
           "marketplace_code": {
@@ -3743,7 +4112,10 @@
         "description": "This model represents a raw external source of information."
       },
       "RegisterRequest": {
-        "required": ["registration_info", "transaction_id"],
+        "required": [
+          "registration_info",
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -3765,7 +4137,10 @@
         "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": {
@@ -3878,7 +4253,10 @@
         "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": {
@@ -3909,7 +4287,9 @@
         "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": {
@@ -3921,76 +4301,11 @@
         "additionalProperties": false,
         "description": "Return Label Information (Added 1.13)"
       },
-      "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"],
+        "required": [
+          "requested_pickup_window",
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -4015,7 +4330,9 @@
         "description": "A request to schedule a pickup with a carrier"
       },
       "SchedulePickupResponse": {
-        "required": ["pickup_windows"],
+        "required": [
+          "pickup_windows"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -4088,7 +4405,10 @@
         "additionalProperties": false
       },
       "SearchRadiusUnit": {
-        "enum": ["miles", "kilometers"],
+        "enum": [
+          "miles",
+          "kilometers"
+        ],
         "type": "string"
       },
       "Service": {
@@ -4149,7 +4469,10 @@
         "additionalProperties": false
       },
       "ServicePointAddress": {
-        "required": ["postal_code", "country_code"],
+        "required": [
+          "postal_code",
+          "country_code"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -4175,11 +4498,17 @@
         "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": [
           {
@@ -4223,7 +4552,10 @@
         "additionalProperties": false
       },
       "ShipFrom": {
-        "required": ["postal_code", "country_code"],
+        "required": [
+          "postal_code",
+          "country_code"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -4244,7 +4576,10 @@
         "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": [
           {
@@ -4255,7 +4590,10 @@
         "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": [
           {
@@ -4350,7 +4688,10 @@
             "$ref": "#/components/schemas/Customs"
           },
           "insured_value": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -4378,7 +4719,9 @@
         "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": {
@@ -4392,7 +4735,10 @@
             "format": "int32"
           },
           "value": {
-            "required": ["currency", "amount"],
+            "required": [
+              "currency",
+              "amount"
+            ],
             "type": "object",
             "properties": {
               "amount": {
@@ -4557,7 +4903,16 @@
         "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"
       },
@@ -4710,7 +5065,9 @@
         "description": "Entity representing a Tax Identification number, type, and country of registration."
       },
       "TaxType": {
-        "enum": ["vat"],
+        "enum": [
+          "vat"
+        ],
         "type": "string"
       },
       "TermsOfTradeCode": {
@@ -4837,7 +5194,10 @@
         "description": "This model represents a tracking event for a shipment."
       },
       "TrackingAttribute": {
-        "required": ["type", "value"],
+        "required": [
+          "type",
+          "value"
+        ],
         "type": "object",
         "properties": {
           "type": {
@@ -4975,7 +5335,9 @@
         "description": "This model represents tracking information for a shipment."
       },
       "TrackingRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -5004,7 +5366,9 @@
         "description": "This model represents the payload that is sent to request tracking information."
       },
       "TrackingResponse": {
-        "required": ["tracking_info"],
+        "required": [
+          "tracking_info"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -5074,11 +5438,17 @@
         "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": [
           {
@@ -5110,7 +5480,9 @@
         "description": "This model represents the successful response for updating carrier settings request."
       },
       "ValidateInboundDataRequest": {
-        "required": ["transaction_id"],
+        "required": [
+          "transaction_id"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -5239,7 +5611,10 @@
         "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": [
           {
@@ -5260,7 +5635,9 @@
         "description": "This model represents the payload sent to void a set of labels."
       },
       "VoidLabelsResponse": {
-        "required": ["void_responses"],
+        "required": [
+          "void_responses"
+        ],
         "type": "object",
         "allOf": [
           {
@@ -5281,7 +5658,10 @@
         "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": [
           {
@@ -5302,7 +5682,9 @@
         "description": "A request to void a particular label."
       },
       "VoidResponse": {
-        "required": ["void_request_id"],
+        "required": [
+          "void_request_id"
+        ],
         "type": "object",
         "properties": {
           "void_request_id": {
@@ -5416,7 +5798,12 @@
         "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."
       },
@@ -5482,4 +5869,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}