@shipengine/connect-carrier-api 2.4.3 → 2.4.4

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "ShipEngine Connect Carrier API",
     "description": "This API specification describes the canonical ShipEngine Carrier API connector module. A module which implements one or more endpoints from this specification can be integrated with the ShipEngine Carrier Platform.",
-    "version": "1.15.0"
+    "version": "1.15.1"
   },
   "paths": {
     "/Register": {
@@ -11,13 +11,13 @@
         "tags": [
           "Account Setup"
         ],
-        "description": "This method is used to authenticate with your application. It is responsible for verifying the supplied user credentials and establishing or renewing a connection. The authentication information will be stored in the metadata object and will be included in all request bodies. All applications must implement the Register method.",
+        "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",
         "parameters": [
           {
             "name": "ShipStation-TransactionID",
             "in": "header",
-            "description": "Uniquely identifies the current transaction. If the transaction is retried, then this transaction_id will remain the same. You can use this to detect and prevent duplicate operations.",
+            "description": "Uniquely identifies the current transaction. If the transaction is retried,\r\n            then this transaction_id will remain the same. You can use this to detect and prevent duplicate\r\n            operations.",
             "schema": {
               "type": "string",
               "format": "uuid"
@@ -25,25 +25,13 @@
           }
         ],
         "requestBody": {
-          "description": "An object containing the authentication information gathered using the connection form you created for your application. It will contain whatever fields you defined in this form. Your method must then use this data to perform authentication with your backend service.",
+          "description": "An object containing the authentication information gathered using the\r\n            connection form you created for your application. It will contain whatever fields you defined in this form.\r\n            Your method must then use this data to perform authentication with your backend service.",
           "content": {
             "application/json": {
               "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"}}
             }
           }
         },
@@ -98,17 +86,7 @@
                 "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"}}
               }
             }
           }
@@ -290,7 +268,7 @@
         "tags": [
           "Manifesting"
         ],
-        "description": "This method creates an end-of-day manifest and should be implemented by carrier apps that support end-of-day 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": "Create Manifest",
         "parameters": [
           {
@@ -375,7 +353,7 @@
         "tags": [
           "Manifesting"
         ],
-        "description": "This method retrieves the end-of-day manifest created by an earlier create manifest call. The CreateManifestRequestId returned in the CreateManifest, is used to find the manifest.",
+        "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": "Get Manifest",
         "parameters": [
           {
@@ -460,13 +438,13 @@
         "tags": [
           "Normalize Inbound Data"
         ],
-        "description": "This method validates and then returns the type of information contained in the inbound data, such as tracking information  Carriers which support webhook based tracking or manifesting updates may choose to implement this endpoint  Note: Changes made to the connection meta-data will not be saved if modified",
+        "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": "Validate Inbound Data",
         "parameters": [
           {
             "name": "ShipStation-TransactionID",
             "in": "header",
-            "description": "Unique transaction ID, use this transaction ID in your logs to correlate a request together.",
+            "description": "Unique transaction ID, use this transaction ID in your logs to correlate a\r\n             request together.",
             "schema": {
               "type": "string",
               "format": "uuid"
@@ -480,24 +458,7 @@
               "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"}}
             }
           }
         },
@@ -555,11 +516,7 @@
                 "examples": {
                   "Tracking": {
                     "summary": "Tracking",
-                    "value": {
-                      "content_types": [
-                        "tracking"
-                      ]
-                    }
+                    "value": {"content_types":["tracking"]}
                   }
                 }
               }
@@ -573,13 +530,13 @@
         "tags": [
           "Normalize Inbound Data"
         ],
-        "description": "This method returns normalized tracking information for one or more shipments based on data send by the carrier  Carriers which support webhook based tracking updates may choose to implement this endpoint  Note: Changes made to the connection meta-data will not be saved if modified",
+        "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": "Normalize Tracking Data",
         "parameters": [
           {
             "name": "ShipStation-TransactionID",
             "in": "header",
-            "description": "Unique transaction ID, use this transaction ID in your logs to correlate a request together.",
+            "description": "Unique transaction ID, use this transaction ID in your logs to correlate a\r\n             request together.",
             "schema": {
               "type": "string",
               "format": "uuid"
@@ -593,24 +550,7 @@
               "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"}}
             }
           }
         },
@@ -668,28 +608,7 @@
                 "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"}
                   }
                 }
               }
@@ -1034,7 +953,7 @@
         "tags": [
           "Rating"
         ],
-        "description": "This method calculates the shipping costs for a shipment, or multiple permutations of a shipment, to allow your customers to select the best rate.  Most carrier apps should implement this method, unless you don't support rating shipments.",
+        "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": "Get Rates",
         "parameters": [
           {
@@ -1204,13 +1123,13 @@
         "tags": [
           "Tracking"
         ],
-        "description": "This method returns tracking information for a shipment, including each of the tracking events that have occurred for the shipment.  Most carrier applications should implement this method, unless you don't support tracking shipments.",
+        "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 a Shipment",
         "parameters": [
           {
             "name": "ShipStation-TransactionID",
             "in": "header",
-            "description": "Unique transaction ID, use this transaction ID in your logs to correlate a request together.",
+            "description": "Unique transaction ID, use this transaction ID in your logs to correlate a\r\n             request together.",
             "schema": {
               "type": "string",
               "format": "uuid"
@@ -1224,32 +1143,7 @@
               "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"}}
             }
           }
         },
@@ -1307,211 +1201,15 @@
                 "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": "11",
-                        "carrier_status_description": "Delivered",
-                        "estimated_delivery_datetime": "2021-08-11T00:00:00",
-                        "actual_delivery_datetime": "2021-08-11T21:15:00Z",
-                        "weight": 500.0,
-                        "dimensions": {
-                          "length": 10.0,
-                          "width": 10.0,
-                          "height": 10.0
-                        },
-                        "service": {
-                          "code": "03",
-                          "name": "UPS® Ground"
-                        },
-                        "packaging": "package",
-                        "package_count": 1,
-                        "events": [
-                          {
-                            "event_datetime": "2021-08-08T21:15:00Z",
-                            "event_datetime_local": "2021-08-08T16:15:00",
-                            "event_code": "3",
-                            "description": "Order Processed: Ready for UPS",
-                            "city": "Austin",
-                            "state": "TX",
-                            "postal_code": "78756",
-                            "country": "US",
-                            "geo": {
-                              "lat": 30.31,
-                              "long": -97.74
-                            },
-                            "status_code": "AC"
-                          },
-                          {
-                            "event_datetime": "2021-08-09T09:15:00Z",
-                            "event_datetime_local": "2021-08-09T04:15:00",
-                            "event_code": "5",
-                            "description": "In Transit",
-                            "city": "Austin",
-                            "state": "TX",
-                            "postal_code": "78756",
-                            "country": "US",
-                            "geo": {
-                              "lat": 30.2,
-                              "long": -97.66
-                            },
-                            "status_code": "IT"
-                          },
-                          {
-                            "event_datetime": "2021-08-10T09:15:00Z",
-                            "event_datetime_local": "2021-08-10T04:15:00",
-                            "event_code": "6",
-                            "description": "On Vehicle for Delivery",
-                            "city": "Los Angeles",
-                            "state": "CA",
-                            "postal_code": "90045",
-                            "country": "US",
-                            "geo": {
-                              "lat": 33.95,
-                              "long": -118.38
-                            },
-                            "status_code": "IT"
-                          },
-                          {
-                            "event_datetime": "2021-08-10T15:15:00Z",
-                            "event_datetime_local": "2021-08-10T10:15:00",
-                            "event_code": "21",
-                            "description": "On Vehicle for Delivery Today",
-                            "city": "Los Angeles",
-                            "state": "CA",
-                            "postal_code": "90045",
-                            "country": "US",
-                            "geo": {
-                              "lat": 33.95,
-                              "long": -118.38
-                            },
-                            "status_code": "IT"
-                          },
-                          {
-                            "event_datetime": "2021-08-10T21:15:00Z",
-                            "event_datetime_local": "2021-08-10T16:15:00",
-                            "event_code": "22",
-                            "description": "First Attempt Made",
-                            "city": "El Segundo",
-                            "state": "CA",
-                            "postal_code": "90245",
-                            "country": "US",
-                            "geo": {
-                              "lat": 33.95,
-                              "long": -118.38
-                            },
-                            "status_code": "AT"
-                          },
-                          {
-                            "event_datetime": "2021-08-11T03:15:00Z",
-                            "event_datetime_local": "2021-08-10T22:15:00",
-                            "event_code": "21",
-                            "description": "On Vehicle for Delivery Today",
-                            "city": "Los Angeles",
-                            "state": "CA",
-                            "postal_code": "90045",
-                            "country": "US",
-                            "geo": {
-                              "lat": 33.95,
-                              "long": -118.38
-                            },
-                            "status_code": "IT"
-                          },
-                          {
-                            "event_datetime": "2021-08-11T21:15:00Z",
-                            "event_datetime_local": "2021-08-11T16:15:00",
-                            "event_code": "11",
-                            "description": "Delivered",
-                            "city": "El Segundo",
-                            "state": "CA",
-                            "postal_code": "90245",
-                            "country": "US",
-                            "geo": {
-                              "lat": 33.95,
-                              "long": -118.38
-                            },
-                            "status_code": "DE"
-                          }
-                        ],
-                        "shipping_problem": false,
-                        "carrierEnum": 0
-                      }
-                    }
+                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-08T21:15:00Z","event_datetime_local":"2021-08-08T16:15:00","event_code":"3","description":"Order Processed: Ready for UPS","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.31,"long":-97.74},"status_code":"AC"},{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-10T09:15:00Z","event_datetime_local":"2021-08-10T04:15:00","event_code":"6","description":"On Vehicle for Delivery","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T15:15:00Z","event_datetime_local":"2021-08-10T10:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T21:15:00Z","event_datetime_local":"2021-08-10T16:15:00","event_code":"22","description":"First Attempt Made","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"AT"},{"event_datetime":"2021-08-11T03:15:00Z","event_datetime_local":"2021-08-10T22:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"11","description":"Delivered","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"DE"}],"shipping_problem":false,"carrierEnum":0}}
                   },
                   "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": "64",
-                        "carrier_status_description": "Delivery Refused",
-                        "estimated_delivery_datetime": "2021-08-11T00:00:00",
-                        "actual_delivery_datetime": "2021-08-11T21:15:00Z",
-                        "weight": 500.0,
-                        "dimensions": {
-                          "length": 10.0,
-                          "width": 10.0,
-                          "height": 10.0
-                        },
-                        "service": {
-                          "code": "03",
-                          "name": "UPS® Ground"
-                        },
-                        "packaging": "package",
-                        "package_count": 1,
-                        "events": [
-                          {
-                            "event_datetime": "2021-08-09T09:15:00Z",
-                            "event_datetime_local": "2021-08-09T04:15:00",
-                            "event_code": "5",
-                            "description": "In Transit",
-                            "city": "Austin",
-                            "state": "TX",
-                            "postal_code": "78756",
-                            "country": "US",
-                            "geo": {
-                              "lat": 30.2,
-                              "long": -97.66
-                            },
-                            "status_code": "IT"
-                          },
-                          {
-                            "event_datetime": "2021-08-11T21:15:00Z",
-                            "event_datetime_local": "2021-08-11T16:15:00",
-                            "event_code": "59",
-                            "description": "Delivery Refused",
-                            "city": "El Segundo",
-                            "state": "CA",
-                            "postal_code": "90245",
-                            "country": "US",
-                            "geo": {
-                              "lat": 33.95,
-                              "long": -118.38
-                            },
-                            "status_code": "EX"
-                          }
-                        ],
-                        "shipping_problem": false,
-                        "carrierEnum": 0
-                      }
-                    }
+                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"EX","carrier_status_code":"64","carrier_status_description":"Delivery Refused","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"59","description":"Delivery Refused","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"EX"}],"shipping_problem":false,"carrierEnum":0}}
                   }
                 }
               }
@@ -1647,8 +1345,8 @@
             "nullable": true
           }
         },
-        "additionalProperties": {},
-        "description": "This is a schemaless object. It is for open ended customizations unique to particular carriers. The documented keys are some common options shared by many carriers, but are not definitive. Advanced options you support will be defined in ShipEngine. If the field is absent it should be interpreted as the default value for any applicable options, e.g. false for booleans."
+        "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": {
         "type": "object",
@@ -1692,7 +1390,7 @@
           },
           "metadata": {
             "type": "object",
-            "additionalProperties": {},
+            "additionalProperties": { },
             "nullable": true
           }
         },
@@ -1703,8 +1401,8 @@
         "properties": {
           "metadata": {
             "type": "object",
-            "additionalProperties": {},
-            "description": "This is an optional schemaless object that you may return with a successful response. Anything returned under this key will be included in all future requests. For example, you may store additional static properties about the end user or their connection to the carrier. The maximum storage size for data under this key is 4KB.",
+            "additionalProperties": { },
+            "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
           }
         },
@@ -1784,12 +1482,12 @@
           },
           "account_number": {
             "type": "string",
-            "description": "Specified if there is an account number associated with the Bill To Party, and the Bill To Party is not the account holder.",
+            "description": "Specified if there is an account number associated with the Bill To Party, and the Bill To Party is\r\nnot the account holder.",
             "nullable": true
           }
         },
         "additionalProperties": false,
-        "description": "Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party other than the shipper (the shipper is considered the default party responsible). CarrierApi.Common.Request.CarrierApi.Common.Models.BillTo extends CarrierApi.Common.Models.Addresses.AddressBase since address fields are often required when associating billing to another account.  Additionally, this allows for a contact to be specified, if necessary."
+        "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.AddressBase 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": [
@@ -1864,7 +1562,7 @@
         "properties": {
           "message": {
             "type": "string",
-            "description": "User facing text describing the cancellation process. May be left blank to present a default value.",
+            "description": "User facing text describing the cancellation process. May be left \r\nblank to present a default value.",
             "nullable": true
           },
           "errors": {
@@ -1872,7 +1570,7 @@
             "items": {
               "type": "string"
             },
-            "description": "A list of errors preventing this notification from being cancelled. If no errors are returned the void is considered successful. If any errors are returned the void is considered failed.",
+            "description": "A list of errors preventing this notification from being cancelled.\r\nIf no errors are returned the void is considered successful. If \r\nany errors are returned the void is considered failed.",
             "nullable": true
           }
         },
@@ -1977,12 +1675,12 @@
         "properties": {
           "service_code": {
             "type": "string",
-            "description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine.",
+            "description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed\r\nto you will be configured in ShipEngine.",
             "nullable": true
           },
           "ship_datetime": {
             "type": "string",
-            "description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the https://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.",
+            "description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.",
             "format": "date-time"
           },
           "confirmation": {
@@ -1996,7 +1694,7 @@
           },
           "is_test_label": {
             "type": "boolean",
-            "description": "Whether this request is the result of a test. When true the request must not result in any financial charges to any party. If the field is absent it should be interpreted as false"
+            "description": "Whether this request is the result of a test. When true the request must not result in any financial charges\r\nto any party. If the field is absent it should be interpreted as false"
           },
           "advanced_options": {
             "$ref": "#/components/schemas/AdvancedOptions"
@@ -2006,7 +1704,7 @@
           },
           "is_return_label": {
             "type": "boolean",
-            "description": "Whether this label is to return a previously shipped package. If the field is absent it should be interpreted as false."
+            "description": "Whether this label is to return a previously shipped package. If the field is absent it should be\r\ninterpreted as false."
           },
           "packages": {
             "type": "array",
@@ -2033,7 +1731,7 @@
           },
           "next_day": {
             "type": "boolean",
-            "description": "Whether this shipment is expected to use a next day service class. If the field is absent it should be interpreted as false",
+            "description": "Whether this shipment is expected to use a next day service class. If the field is absent it\r\nshould be interpreted as false",
             "nullable": true
           },
           "international": {
@@ -2057,7 +1755,7 @@
             "items": {
               "$ref": "#/components/schemas/Document"
             },
-            "description": "Attachments that may be required to be sent to the carrier, in particular customs documents or commercial invoices.",
+            "description": "Attachments that may be required to be sent to the carrier, in particular customs documents or\r\ncommercial invoices.",
             "nullable": true
           },
           "bill_shipping_to": {
@@ -2092,7 +1790,7 @@
             "items": {
               "$ref": "#/components/schemas/Document"
             },
-            "description": "Shipment level documents should be used if documents are not returned at a package level. DO NOT include duplicate documents intentionally, a document should only be added to the CreateLabelResponse or to the LabelPackage.",
+            "description": "Shipment level documents should be used if documents are not returned at a package level.\r\nDO NOT include duplicate documents intentionally, a document should only be added to the CreateLabelResponse\r\nor to the LabelPackage.",
             "nullable": true
           },
           "packages": {
@@ -2100,7 +1798,7 @@
             "items": {
               "$ref": "#/components/schemas/LabelPackage"
             },
-            "description": "Package information returned for each requested package in the shipment. Note: The order of the packages returned should match the order of the packages in the request.",
+            "description": "Package information returned for each requested package in the shipment.\r\nNote: The order of the packages returned should match the order of the packages in the request.",
             "nullable": true
           },
           "billing_line_items": {
@@ -2113,7 +1811,7 @@
           },
           "tracking_number": {
             "type": "string",
-            "description": "The carrier specific tracking identifier for this shipment; if a multi-package shipment, this should be the lead tracking number.",
+            "description": "The carrier specific tracking identifier for this shipment; if a multi-package shipment, this should be\r\nthe lead tracking number.",
             "nullable": true
           },
           "trackable": {
@@ -2131,7 +1829,7 @@
           },
           "estimated_delivery_datetime": {
             "type": "string",
-            "description": "The estimated date and time for when the shipment will be delivered. Formatted per the https://tools.ietf.org/html/rfc3339 spec.",
+            "description": "The estimated date and time for when the shipment will be delivered. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec.",
             "format": "date-time",
             "nullable": true,
             "example": "1937-01-01T12:00:27.87+00:20"
@@ -2183,13 +1881,13 @@
           },
           "open_datetime": {
             "type": "string",
-            "description": "The date and time of the earliest shipment being manifested. Formatted per the https://tools.ietf.org/html/rfc3339 spec",
+            "description": "The date and time of the earliest shipment being manifested. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec",
             "format": "date-time",
             "nullable": true
           },
           "close_datetime": {
             "type": "string",
-            "description": "The date and time of the last shipment being manifested. Formatted per the https://tools.ietf.org/html/rfc3339 spec",
+            "description": "The date and time of the last shipment being manifested. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec",
             "format": "date-time"
           },
           "advanced_options": {
@@ -2250,8 +1948,8 @@
           },
           "manifest_identifiers": {
             "type": "object",
-            "additionalProperties": {},
-            "description": "Carrier information needed to get created manifests. Only needed if carrier requires two calls to create and get manifests.",
+            "additionalProperties": { },
+            "description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
             "nullable": true
           }
         },
@@ -2317,7 +2015,7 @@
           }
         },
         "additionalProperties": false,
-        "description": "The credentials that will be used to access this carrier's services. These will be sent as a Basic Authorization header with all future requests."
+        "description": "The credentials that will be used to access this carrier's services. These will be sent as a\r\nBasic Authorization header with all future requests."
       },
       "Customs": {
         "type": "object",
@@ -2347,7 +2045,7 @@
                 "description": "Alpha-3 currency code complying with ISO 4217."
               }
             },
-            "description": "Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper.",
+            "description": "Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed\r\nto the shipper.",
             "nullable": true
           },
           "duties_paid": {
@@ -2361,7 +2059,7 @@
                 "description": "Alpha-3 currency code complying with ISO 4217."
               }
             },
-            "description": "The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments.",
+            "description": "The amount of duties paid by the shipper, if any. This is generally only necessary for DDP\r\n(bill_duties_to_sender) shipments.",
             "nullable": true
           },
           "bill_duties_to": {
@@ -2385,7 +2083,7 @@
         "properties": {
           "description": {
             "type": "string",
-            "description": "A user specified free form string describing this customs item. If the field is absent the user has not specified a description.",
+            "description": "A user specified free form string describing this customs item. If the field is absent the user has\r\nnot specified a description.",
             "nullable": true
           },
           "quantity": {
@@ -2404,7 +2102,7 @@
                 "description": "Alpha-3 currency code complying with ISO 4217."
               }
             },
-            "description": "The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs.",
+            "description": "The user specified declared customs value of this customs item. Generally, this value needs to be greater\r\nthan 0 to be accepted through customs.",
             "nullable": true
           },
           "country_of_origin": {
@@ -2536,7 +2234,7 @@
             "items": {
               "$ref": "#/components/schemas/DocumentType"
             },
-            "description": "The document type(s) being returned. In most cases this is just a single document type; however, some carriers return multiple document types in the same PDF or ZPL.",
+            "description": "The document type(s) being returned. In most cases this is just a single document type; however, some\r\ncarriers return multiple document types in the same PDF or ZPL.",
             "nullable": true
           },
           "data": {
@@ -2576,7 +2274,7 @@
             "items": {
               "$ref": "#/components/schemas/DetailedError"
             },
-            "description": "A list of detailed errors that occurred for this request. Remove all personally identifiable information.",
+            "description": "A list of detailed errors that occurred for this request.\r\nRemove all personally identifiable information.",
             "nullable": true
           }
         },
@@ -2604,7 +2302,7 @@
           }
         ],
         "additionalProperties": false,
-        "description": "This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response."
+        "description": "This provides any additional forms that go with the label. For example, customs forms. Exactly one of the\r\nkeys should be populated. Set href is the forms should be downloaded separately. Set data if the\r\nforms are returned directly in the response."
       },
       "FulfillmentPlanDetails": {
         "type": "object",
@@ -2681,11 +2379,11 @@
           },
           "return_immediately": {
             "type": "boolean",
-            "description": "Return immediately after checking status. Full manifest creation can take up to 2 minutes. Set to false to allow additional checks before timeout."
+            "description": "Return immediately after checking status.\r\nFull manifest creation can take up to 2 minutes.\r\nSet to false to allow additional checks before timeout."
           },
           "manifest_identifiers": {
             "type": "object",
-            "additionalProperties": {},
+            "additionalProperties": { },
             "description": "Carrier specific data needed to retrieve Manifest results",
             "nullable": true
           }
@@ -2703,12 +2401,12 @@
         "properties": {
           "service_code": {
             "type": "string",
-            "description": "If present, a specific service is being requested, and that is the only rate required to fulfill the request. The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine.",
+            "description": "If present, a specific service is being requested, and that is the only rate required to fulfill the request.\r\nThe service code uniquely identifies a shipping service that you offer.\r\nWhich service codes can be passed to you will be configured in ShipEngine.",
             "nullable": true
           },
           "ship_datetime": {
             "type": "string",
-            "description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the https://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.",
+            "description": "When the package is expected to ship. Not guaranteed to be in the future. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec. Will always be in UTC.",
             "format": "date-time"
           },
           "confirmation": {
@@ -2722,7 +2420,7 @@
           },
           "is_return_label": {
             "type": "boolean",
-            "description": "Whether this label is to return a previously shipped package. If the field is absent it should be interpreted as false."
+            "description": "Whether this label is to return a previously shipped package. If the field is absent it should be\r\ninterpreted as false."
           },
           "packages": {
             "type": "array",
@@ -2751,7 +2449,7 @@
           },
           "next_day": {
             "type": "boolean",
-            "description": "Whether this shipment is expected to use a next day service class. If the field is absent it should be interpreted as false",
+            "description": "Whether this shipment is expected to use a next day service class. If the field is absent it\r\nshould be interpreted as false",
             "nullable": true
           },
           "fulfillment_plan_details": {
@@ -2780,7 +2478,7 @@
             "items": {
               "$ref": "#/components/schemas/Rate"
             },
-            "description": "A list of rates for shipping services. If you use service codes there may be exactly one rate returned for the requested service. If you use service codes there may be more than one rate to provide additional options. If you don't use service codes there may be one or more rates. If you don't provide real time rates you should return a single hard coded zero value rate.",
+            "description": "A list of rates for shipping services. If you use service codes there may be exactly one rate returned for\r\nthe requested service. If you use service codes there may be more than one rate to provide additional\r\noptions. If you don't use service codes there may be one or more rates. If you don't provide real time\r\nrates you should return a single hard coded zero value rate.",
             "nullable": true
           }
         },
@@ -2797,7 +2495,12 @@
         "properties": {
           "service_code": {
             "type": "string",
-            "description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine.",
+            "description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed\r\nto you will be configured in ShipEngine.",
+            "nullable": true
+          },
+          "city_locality": {
+            "type": "string",
+            "description": "The city locality to use when searching for available relay points.",
             "nullable": true
           },
           "postal_code": {
@@ -2878,7 +2581,7 @@
           }
         ],
         "additionalProperties": false,
-        "description": "This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response."
+        "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": [
@@ -2926,7 +2629,7 @@
             "items": {
               "$ref": "#/components/schemas/Document"
             },
-            "description": "Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CarrierApi.Common.Response.CreateLabelResponse level.",
+            "description": "Documents associated with this package, if documents are not specified at a package level, use the\r\nDocuments array at the CarrierApi.Common.Response.CreateLabelResponse level.",
             "nullable": true
           }
         },
@@ -3309,7 +3012,7 @@
         "properties": {
           "service_code": {
             "type": "string",
-            "description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine. If this field is missing, the rate will be discarded.",
+            "description": "The service code uniquely identifies a shipping service that you offer. Which service codes can be passed\r\nto you will be configured in ShipEngine.\r\nIf this field is missing, the rate will be discarded.",
             "nullable": true
           },
           "package_type": {
@@ -3319,13 +3022,13 @@
           },
           "ship_datetime": {
             "type": "string",
-            "description": "When the package should ship for this rate to be valid. ** This differs from previous documentation Formatted per the https://tools.ietf.org/html/rfc3339 spec. Must be in UTC.",
+            "description": "When the package should ship for this rate to be valid. ** This differs from previous documentation\r\nFormatted per the https://tools.ietf.org/html/rfc3339 spec. Must be in UTC.",
             "format": "date-time",
             "nullable": true
           },
           "estimated_delivery_datetime": {
             "type": "string",
-            "description": "When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC.",
+            "description": "When the package(s) in this shipment are expected to arrive at their destination.\r\nFormatted per https://tools.ietf.org/html/rfc3339. Must be in UTC.",
             "format": "date-time",
             "nullable": true
           },
@@ -3350,7 +3053,7 @@
             "items": {
               "type": "string"
             },
-            "description": "A list of discrete warnings. This should be data the end user needs to be aware of. These should not stop the request from succeeding, or a label being purchased with this rate.",
+            "description": "A list of discrete warnings. This should be data the end user needs to be aware of.\r\nThese should not stop the request from succeeding, or a label being purchased with this rate.",
             "nullable": true
           },
           "negotiated_rate": {
@@ -3400,8 +3103,8 @@
         "properties": {
           "registration_info": {
             "type": "object",
-            "additionalProperties": {},
-            "description": "This is a schemaless object used to contain any required fields for validating a users credentials or registering a new account. These fields will be custom to the shipping service provider, and will be collected via a form and sent over as key value pairs.",
+            "additionalProperties": { },
+            "description": "This is a schemaless object used to contain any required fields for validating a users credentials or\r\nregistering a new account. These fields will be custom to the shipping service provider, and will be\r\ncollected via a form and sent over as key value pairs.",
             "nullable": true
           }
         },
@@ -3416,8 +3119,8 @@
           },
           "metadata": {
             "type": "object",
-            "additionalProperties": {},
-            "description": "This is an optional schemaless object that should be returned for persisted auth and user information. Anything returned under this key will be included in all future requests. For example, you may store additional static properties about the end user or their connection to the carrier. The maximum storage size for data under this key is 4KB.",
+            "additionalProperties": { },
+            "description": "This is an optional schemaless object that should be returned for persisted auth and user information.\r\nAnything returned under this key will be included in all future requests. For example, you may store\r\nadditional static properties about the end user or their connection to the carrier. The maximum\r\nstorage size for data under this key is 4KB.",
             "nullable": true
           }
         },
@@ -3526,7 +3229,7 @@
         "properties": {
           "rma_number": {
             "type": "string",
-            "description": "A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return.",
+            "description": "A return merchandise authorization (RMA) is an associated number assigned to process the return, this\r\nnumber is often printed on the label, and used when the original shipper processes the inbound return.",
             "nullable": true
           }
         },
@@ -3646,7 +3349,7 @@
           }
         ],
         "additionalProperties": false,
-        "description": "The address that should be displayed as the return address, only if the shipping provider supports this functionality."
+        "description": "The address that should be displayed as the return address, only if the shipping provider supports\r\nthis functionality."
       },
       "ShipmentIdentifier": {
         "type": "object",
@@ -3736,7 +3439,7 @@
           }
         },
         "additionalProperties": false,
-        "description": "This model represents a shipment that has already been shipped, and contains summary information about the shipment."
+        "description": "This model represents a shipment that has already been shipped, and contains\r\nsummary information about the shipment."
       },
       "ShipTo": {
         "type": "object",
@@ -3787,7 +3490,7 @@
           "NY"
         ],
         "type": "string",
-        "description": "This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System"
+        "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"
       },
       "TaxIdentificationType": {
         "enum": [
@@ -4131,7 +3834,7 @@
           }
         },
         "additionalProperties": false,
-        "description": "This model represents the payload that is sent to validate inbound data requests (e.g. webhooks) and determine what type information is contained in the data."
+        "description": "This model represents the payload that is sent to validate inbound data requests (e.g. webhooks) and determine\r\nwhat type information is contained in the data."
       },
       "ValidateInboundDataResponse": {
         "type": "object",
@@ -4231,7 +3934,7 @@
             "items": {
               "type": "string"
             },
-            "description": "A list of errors preventing this label from being voided. If no errors are returned the void is considered successful. If any errors are returned the void is considered failed.",
+            "description": "A list of errors preventing this label from being voided. If no errors are returned the void is considered\r\nsuccessful. If any errors are returned the void is considered failed.",
             "nullable": true
           },
           "billing_line_items": {
@@ -4314,7 +4017,7 @@
     },
     {
       "name": "Shipment Notifications",
-      "description": "Shipment notifications were designed to notify a Pickup/Drop Off (PUDO) provider that a parcel is enroute to their location. These endpoints allow for carrier agnostic PUDO locations to expect and plan for the arrival of the parcel."
+      "description": "Shipment notifications were designed to notify a Pickup/Drop Off (PUDO) provider that a parcel is enroute to their location.  These endpoints allow for carrier agnostic PUDO locations to expect and plan for the arrival of the parcel."
     },
     {
       "name": "Normalize Inbound Data",