@shipengine/connect-carrier-api 4.1.0 → 4.1.2

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.17.3"
+    "version": "1.18.1"
   },
   "paths": {
     "/Register": {
@@ -576,7 +576,7 @@
         "tags": [
           "Tracking"
         ],
-        "description": "This method returns imported tracking events for a connection, and should only be implemented if you support\r\nimporting tracking data in bulk via file exchange or API requests.\r\n            \r\nAny information needed to retrieve tracking data for a connection should be collected in your registration\r\nform and will be made available as metadata in the request.",
+        "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": {
           "description": "An object containing information about the connection to import tracking events for.",
@@ -604,6 +604,37 @@
           }
         }
       }
+    },
+    "/ValidateShipment": {
+      "post": {
+        "tags": [
+          "Validations"
+        ],
+        "description": "This method validates a shipment against carrier constraints for selected service.",
+        "operationId": "ValidateShipment",
+        "requestBody": {
+          "description": "An object containing information about the shipment and selected services to validate.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ValidateShipmentRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "This object model represents the response from a successful validate shipment request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ValidateShipmentResponse"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -819,6 +850,39 @@
         },
         "additionalProperties": false
       },
+      "BillTo": {
+        "required": [
+          "postal_code",
+          "country_code"
+        ],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AddressWithContact"
+          }
+        ],
+        "properties": {
+          "bill_to_party": {
+            "$ref": "#/components/schemas/BillToParty"
+          },
+          "account_number": {
+            "type": "string",
+            "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\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"
+        ],
+        "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."
+      },
       "BillingCategories": {
         "enum": [
           "uncategorized",
@@ -838,7 +902,9 @@
           "oversize",
           "returns",
           "notifications",
-          "tip"
+          "tip",
+          "duties_and_taxes",
+          "brokerage_fee"
         ],
         "type": "string"
       },
@@ -889,76 +955,6 @@
         },
         "additionalProperties": false
       },
-      "BillTo": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
-        "type": "object",
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/AddressWithContact"
-          }
-        ],
-        "properties": {
-          "bill_to_party": {
-            "$ref": "#/components/schemas/BillToParty"
-          },
-          "account_number": {
-            "type": "string",
-            "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\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"
-        ],
-        "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."
-      },
-      "CancellationDetails": {
-        "required": [
-          "reason"
-        ],
-        "type": "object",
-        "properties": {
-          "reason": {
-            "$ref": "#/components/schemas/CancellationReason"
-          },
-          "cancellation_options": {
-            "type": "object",
-            "additionalProperties": {
-              "type": "string"
-            },
-            "description": "Additional properties about the cancellation",
-            "nullable": true
-          },
-          "remarks": {
-            "type": "string",
-            "description": "Remarks about why the customer is cancelling the pickup",
-            "nullable": true
-          }
-        },
-        "additionalProperties": false,
-        "description": "This model contains the explanation of why a user is cancelling a pickup."
-      },
-      "CancellationReason": {
-        "enum": [
-          "other",
-          "not_ready",
-          "cost_too_high",
-          "service_too_slow",
-          "carrier_failed_pickup"
-        ],
-        "type": "string",
-        "description": "An enumeration of common reasons cancellations occur"
-      },
       "CancelNotificationRequest": {
         "required": [
           "transaction_id"
@@ -1092,6 +1088,44 @@
         "additionalProperties": false,
         "description": "This model represents a response for a successful cancel pickup request."
       },
+      "CancellationDetails": {
+        "required": [
+          "reason"
+        ],
+        "type": "object",
+        "properties": {
+          "reason": {
+            "$ref": "#/components/schemas/CancellationReason"
+          },
+          "cancellation_options": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "nullable": true
+            },
+            "description": "Additional properties about the cancellation",
+            "nullable": true
+          },
+          "remarks": {
+            "type": "string",
+            "description": "Remarks about why the customer is cancelling the pickup",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model contains the explanation of why a user is cancelling a pickup."
+      },
+      "CancellationReason": {
+        "enum": [
+          "other",
+          "not_ready",
+          "cost_too_high",
+          "service_too_slow",
+          "carrier_failed_pickup"
+        ],
+        "type": "string",
+        "description": "An enumeration of common reasons cancellations occur"
+      },
       "CodPaymentType": {
         "enum": [
           "any",
@@ -1143,6 +1177,45 @@
         ],
         "type": "string"
       },
+      "PackagingGroupTypes": {
+        "enum": [
+          "i",
+          "ii",
+          "iii"
+        ],
+        "type": "string",
+        "description": "An enumeration for packaging group for dangerous goods."
+      },
+      "PackageInstructionSectionTypes": {
+        "enum": [
+          "section_1",
+          "section_2",
+          "section_1A",
+          "section_1B"
+        ],
+        "type": "string",
+        "description": "An enumeration for package instruction for dangerous goods."
+      },
+      "TransportMeanTypes": {
+        "enum": [
+          "ground",
+          "water",
+          "cao",
+          "pa"
+        ],
+        "type": "string",
+        "description": "An enumeration for transport means for dangerous goods."
+      },
+      "RegulationLevelTypes": {
+        "enum": [
+          "lightly_regulated",
+          "fully_regulated",
+          "limited_quantities",
+          "excepted_quantity"
+        ],
+        "type": "string",
+        "description": "An enumeration for regulation type for dangerous goods."
+      },
       "CreateLabelRequest": {
         "required": [
           "service_code",
@@ -1821,6 +1894,14 @@
         "additionalProperties": false,
         "description": "This model represents the dimensions for a package represented in its original unit, inches, and centimeters."
       },
+      "DimensionUnit": {
+        "enum": [
+          "inches",
+          "centimeters"
+        ],
+        "type": "string",
+        "description": "This model represents the supported units for dimensions."
+      },
       "Dimensions": {
         "type": "object",
         "properties": {
@@ -1846,14 +1927,6 @@
         "additionalProperties": false,
         "description": "This model represents the measurements for dimensions."
       },
-      "DimensionUnit": {
-        "enum": [
-          "inches",
-          "centimeters"
-        ],
-        "type": "string",
-        "description": "This model represents the supported units for dimensions."
-      },
       "DisplayScheme": {
         "enum": [
           "label",
@@ -2311,6 +2384,18 @@
         "additionalProperties": false,
         "description": "A key value pair, allowing custom properties to be stored."
       },
+      "ImportTrackingEventsRequest": {
+        "required": [
+          "transaction_id"
+        ],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseRequest"
+          }
+        ],
+        "additionalProperties": false
+      },
       "ImportedTrackingEvent": {
         "type": "object",
         "properties": {
@@ -2405,18 +2490,6 @@
         "additionalProperties": false,
         "description": "Basic structure for a Importer Record"
       },
-      "ImportTrackingEventsRequest": {
-        "required": [
-          "transaction_id"
-        ],
-        "type": "object",
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/BaseRequest"
-          }
-        ],
-        "additionalProperties": false
-      },
       "InboundDataContentTypes": {
         "enum": [
           "tracking"
@@ -2727,11 +2800,114 @@
           },
           "customs": {
             "$ref": "#/components/schemas/Customs"
+          },
+          "dangerous_goods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DangerousGoods"
+            },
+            "description": "List of dangerous Goods model associated with this package passed to the carrier.",
+            "nullable": true
           }
         },
         "additionalProperties": false,
         "description": "This model represents an individual package that is part of a shipment."
       },
+      "DangerousGoods": {
+        "type": "object",
+        "properties": {
+          "id_number": {
+            "type": "string",
+            "description": "UN number to identify the dangerous goods.",
+            "nullable": true
+          },
+          "shipping_name": {
+            "type": "string",
+            "description": "Trade description of the dangerous goods.",
+            "nullable": true
+          },
+          "technical_name": {
+            "type": "string",
+            "description": "Recognized Technical or chemical name of dangerous goods.",
+            "nullable": true
+          },
+          "product_class": {
+            "type": "string",
+            "description": "Dangerous goods product class based on regulation.",
+            "nullable": true
+          },
+          "product_class_subsidiary": {
+            "type": "string",
+            "description": "A secondary of product class for substances presenting more than one particular hazard.",
+            "nullable": true
+          },
+          "packaging_group": {
+            "$ref": "#/components/schemas/PackagingGroupTypes"
+          },
+          "dangerous_amount": {
+            "type": "string",
+            "description": "The amount of the dangerous goods.",
+            "nullable": true
+          },
+          "quantity": {
+            "type": "number",
+            "description": "Quantity of dangerous goods.",
+            "format": "double",
+            "nullable": true
+          },
+          "packaging_instruction": {
+            "type": "string",
+            "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.",
+            "nullable": true
+          },
+          "packaging_instruction_section": {
+            "$ref": "#/components/schemas/PackageInstructionSectionTypes"
+          },
+          "packaging_type": {
+            "type": "string",
+            "description": "The type of exterior packaging used to contain the dangerous good.",
+            "nullable": true
+          },
+          "transport_mean": {
+            "$ref": "#/components/schemas/TransportMeanTypes"
+          },
+          "transport_category": {
+            "type": "string",
+            "description": "Transport category assign to dangerous goods for the transport purpose.",
+            "nullable": true
+          },
+          "regulation_authority": {
+            "type": "string",
+            "description": "Name of the regulatory authority.",
+            "nullable": true
+          },
+          "regulation_level": {
+            "$ref": "#/components/schemas/RegulationLevelTypes"
+          },
+          "radioactive": {
+            "type": "boolean",
+            "description": "Indication if the substance is radioactive.",
+            "nullable": true
+          },
+          "reportable_quantity": {
+            "type": "boolean",
+            "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.",
+            "nullable": true
+          },
+          "tunnel_code": {
+            "type": "string",
+            "description": "Defines which types of tunnels the shipment is allowed to go through.",
+            "nullable": true
+          },
+          "additional_description": {
+            "type": "string",
+            "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents an dangerous good information that is part of a package."
+      },
       "PickupConfirmation": {
         "type": "object",
         "properties": {
@@ -3430,6 +3606,29 @@
         "additionalProperties": false,
         "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"
+        ],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AddressWithContact"
+          }
+        ],
+        "properties": {
+          "tax_identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TaxIdentifier"
+            },
+            "description": "Tax IDs associated with the consignee.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "ShipmentIdentifier": {
         "type": "object",
         "properties": {
@@ -3548,29 +3747,6 @@
         "additionalProperties": false,
         "description": "This model represents a shipment that has already been shipped, and contains\r\nsummary information about the shipment."
       },
-      "ShipTo": {
-        "required": [
-          "postal_code",
-          "country_code"
-        ],
-        "type": "object",
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/AddressWithContact"
-          }
-        ],
-        "properties": {
-          "tax_identifiers": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/TaxIdentifier"
-            },
-            "description": "Tax IDs associated with the consignee.",
-            "nullable": true
-          }
-        },
-        "additionalProperties": false
-      },
       "StandardizedStatusCodes": {
         "enum": [
           "UN",
@@ -3981,6 +4157,85 @@
         "additionalProperties": false,
         "description": "This model represents the successful response from a validate inbound data request."
       },
+      "ValidateShipmentError": {
+        "type": "object",
+        "properties": {
+          "field_name": {
+            "type": "string",
+            "description": "This is validated field name.",
+            "nullable": true,
+            "example": "ship_to.postal_code"
+          },
+          "field_value": {
+            "type": "string",
+            "description": "This is a validated field value.",
+            "nullable": true,
+            "example": "85001"
+          },
+          "carrier_error_code": {
+            "$ref": "#/components/schemas/ValidationErrorCodes"
+          },
+          "message": {
+            "type": "string",
+            "description": "A user friendly message about this error.",
+            "nullable": true,
+            "example": "Receiver postal code cannot be null"
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represented a validation error"
+      },
+      "ValidateShipmentRequest": {
+        "required": [
+          "service_code",
+          "ship_datetime",
+          "is_return_label",
+          "is_residential",
+          "packages",
+          "ship_to",
+          "ship_from",
+          "transaction_id"
+        ],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CreateLabelRequest"
+          }
+        ],
+        "additionalProperties": false
+      },
+      "ValidateShipmentResponse": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseResponse"
+          }
+        ],
+        "properties": {
+          "validation_errors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ValidateShipmentError"
+            },
+            "description": "This is the validation results list contains list of carrier data constrain issues for requested service.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the successful response from carrier validate shipment data request."
+      },
+      "ValidationErrorCodes": {
+        "enum": [
+          "unspecified",
+          "field_value_required",
+          "invalid_field_value",
+          "invalid_string_length",
+          "invalid_date",
+          "return_label_not_supported"
+        ],
+        "type": "string",
+        "description": "A list of standard validation error identifiers for errors the module can return"
+      },
       "VoidLabelsRequest": {
         "required": [
           "void_requests",
@@ -4185,6 +4440,10 @@
       "name": "Account Setup",
       "description": ""
     },
+    {
+      "name": "Validations",
+      "description": ""
+    },
     {
       "name": "Rating",
       "description": ""

package/src/models/dangerous-good/dangerous-goods.ts

@@ -0,0 +1,46 @@
+import { PackageInstructionSectionTypes } from './package-instruction-section-types';
+import { PackagingGroupTypes } from './packaging-group-types';
+import { RegulationLevelTypes } from './regulation-level-types';
+import { TransportMeanTypes } from './transport-mean-types';
+
+/** @description Basic structure for a dangerous goods */
+export class DangerousGoods {
+  /** @description UN number to identify the dangerous goods */
+  id_number?: string;
+  /** @description Trade description of the dangerous goods */
+  shipping_name?: string;
+  /** @description Recognized Technical or chemical name of dangerous goods */
+  technical_name?: string;
+  /** @description Dangerous goods product class based on regulation */
+  product_class?: string;
+  /** @description A secondary of product class for substances presenting more than one particular hazard */
+  product_class_subsidiary?: string;
+  /** @description This indicates the packaging group based on the degree of danger */
+  packaging_group?: PackagingGroupTypes;
+  /** @description The amount of the dangerous goods */
+  dangerous_amount?: string;
+  /** @description Quantity of dangerous goods */
+  quantity?: number;
+  /** @description The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container */
+  packaging_instruction?: string;
+  /** @description Complementary information to specify the exact 'Section of Packaging' instructions */
+  packaging_instruction_section?: PackageInstructionSectionTypes;
+  /** @description The type of exterior packaging used to contain the dangerous good */
+  packaging_type?: string;
+  /** @description Transportation means through which the dangerous goods are transported */
+  transport_mean?: TransportMeanTypes;
+  /** @description Transport category assign to dangerous goods for the transport purpose */
+  transport_category?: string;
+  /** @description Name of the regulatory authority */
+  regulation_authority?: string;
+  /** @description Regulation level of the dangerous goods */
+  regulation_level?: RegulationLevelTypes;
+  /** @description Indication if the substance is radioactive */
+  radioactive?: boolean;
+  /** @description Indication if the substance needs to be reported to regulatory authority based on the quantity */
+  reportable_quantity?: boolean;
+  /** @description Defines which types of tunnels the shipment is allowed to go through */
+  tunnel_code?: string;
+  /** @description Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier */
+  additional_description?: string;
+}

package/src/models/dangerous-good/package-instruction-section-types.ts

@@ -0,0 +1,7 @@
+/** @description Complementary information to specify the exact 'Section of Packaging' Instructions (a mandatory piece of data for processing lithium batteries shipments). */
+export enum PackageInstructionSectionTypes {
+  Section1 = 'section_1',
+  Section2 = 'section_2',
+  Section1A = 'section_1A',
+  Section1B = 'section_1B',
+}

package/src/models/dangerous-good/packaging-group-types.ts

@@ -0,0 +1,9 @@
+/** @description Types of packaging group for dangerous good and it indicates the degree of danger */
+export enum PackagingGroupTypes {
+  /** @description level 1 */
+  i = 'i',
+  /** @description level 2 */
+  ii = 'ii',
+  /** @description level 3 */
+  iii = 'iii',
+}

package/src/models/dangerous-good/regulation-level-types.ts

@@ -0,0 +1,11 @@
+/** @description Types of regulation level defined for dangerous good */
+export enum RegulationLevelTypes {
+  /** @description lightly regulated */
+  LightlyRegulated = 'lightly_regulated',
+  /** @description fully regualted */
+  FullyRegulated = 'fully_regulated',
+  /** @description limited quantities regulated */
+  LimitedQuantities = 'limited_quantities',
+  /** @description excepted quantity regulated */
+  ExceptedQuantity = 'excepted_quantity',
+}