435 lines
1.4 MiB
435 lines
1.4 MiB
from __future__ import annotations
|
|
|
|
import base64
|
|
import json
|
|
import re
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
import httpx
|
|
from a2a_pack.deepagents import create_a2a_deep_agent
|
|
from langchain_core.messages import BaseMessage
|
|
from langchain_core.tools import StructuredTool
|
|
from pydantic import BaseModel, Field
|
|
|
|
from a2a_pack import (
|
|
A2AAgent,
|
|
ConsumerSetup,
|
|
ConsumerSetupField,
|
|
ConsumerSetupMissing,
|
|
EgressPolicy,
|
|
LLMProvisioning,
|
|
Pricing,
|
|
Resources,
|
|
RunContext,
|
|
skill,
|
|
)
|
|
|
|
|
|
DEFAULT_BASE_URL = "https://api.shipengine.com"
|
|
OPERATIONS = json.loads("{\n \"add_funds_to_carrier\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Add Funds To A Carrier\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"add_funds_to_carrier\",\n \"parameters\": [\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/carriers/{carrier_id}/add_funds\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An add funds to carrier request body\",\n \"title\": \"add_funds_to_carrier_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"add_funds_to_carrier\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Add Funds To Carrier\",\n \"tags\": [\n \"carriers\"\n ]\n },\n \"add_funds_to_insurance\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100,\\nand may want to add funds to insurance rather than keeping the account funded.\\n\",\n \"destructive\": true,\n \"method\": \"PATCH\",\n \"operation_id\": \"add_funds_to_insurance\",\n \"parameters\": [],\n \"path\": \"/v1/insurance/shipsurance/add_funds\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An add funds to insurance request body\",\n \"title\": \"add_funds_to_insurance_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"add_funds_to_insurance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Add Funds To Insurance\",\n \"tags\": [\n \"insurance\"\n ]\n },\n \"add_to_batch\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Add a Shipment or Rate to a Batch\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"add_to_batch\",\n \"parameters\": [\n {\n \"description\": \"Batch ID\",\n \"in\": \"path\",\n \"name\": \"batch_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches/{batch_id}/add\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A modify batch object\",\n \"properties\": {\n \"rate_ids\": {\n \"description\": \"Array of Rate IDs to be modifed on the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The Rate ID to be modified on the batch\"\n },\n \"type\": \"array\"\n },\n \"shipment_ids\": {\n \"description\": \"The Shipment Ids to be modified on the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The Shipment ID to be modified on the batch\"\n },\n \"type\": \"array\"\n }\n },\n \"title\": \"modify_batch\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An add to batch request body\",\n \"title\": \"add_to_batch_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"add_to_batch\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Add to a Batch\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"calculate_rates\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option;\\nso we provide functionality to show you all your options!\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"calculate_rates\",\n \"parameters\": [],\n \"path\": \"/v1/rates\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"properties\": {\n \"rate_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A rate request body\",\n \"properties\": {\n \"calculate_tax_amount\": {\n \"description\": \"Calculate the duties and tariffs for cross border shipments.\",\n \"type\": \"boolean\"\n },\n \"carrier_ids\": {\n \"description\": \"Array of carrier ids to get rates for\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"carrier ids\"\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"is_return\": {\n \"description\": \"Indicate if it's a return shipment\",\n \"type\": \"boolean\"\n },\n \"package_types\": {\n \"items\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"preferred_currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n },\n \"rate_type\": {\n \"description\": \"Indicates what type of rating to perform\",\n \"enum\": [\n \"check\",\n \"shipment\",\n \"quick\"\n ],\n \"type\": \"string\"\n },\n \"service_codes\": {\n \"items\": {\n \"description\": \"Item Service Codes\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"carrier_ids\"\n ],\n \"title\": \"rate_request_body\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The rate options\"\n }\n },\n \"title\": \"rate_request_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A rate shipment request body\",\n \"oneOf\": [\n {\n \"properties\": {\n \"shipment_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the shipment\"\n }\n },\n \"title\": \"shipment_id_request\",\n \"type\": \"object\"\n },\n {\n \"properties\": {\n \"shipment\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"properties\": {\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"no_validation\"\n }\n },\n \"title\": \"validate_shipment_fields\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\\n\",\n \"properties\": {\n \"advanced_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": true,\n \"description\": \"Advanced shipment options\",\n \"properties\": {\n \"additional_handling\": {\n \"default\": null,\n \"description\": \"Indicate to the carrier that this shipment requires additional handling.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"bill_to_account\": {\n \"default\": null,\n \"description\": \"This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bill_to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true\n },\n \"bill_to_party\": {\n \"allOf\": [\n {\n \"description\": \"The possible bill to party values\",\n \"enum\": [\n \"recipient\",\n \"third_party\"\n ],\n \"title\": \"bill_to_party\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\\n\",\n \"nullable\": true\n },\n \"bill_to_postal_code\": {\n \"default\": null,\n \"description\": \"The postal code of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"certificate_number\": {\n \"default\": null,\n \"description\": \"certificate_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 784515,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"collect_on_delivery\": {\n \"description\": \"Defer payment until package is delivered, instead of when it is ordered.\",\n \"properties\": {\n \"payment_amount\": {\n \"properties\": {\n \"amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"payment_amount\",\n \"type\": \"object\"\n },\n \"payment_type\": {\n \"allOf\": [\n {\n \"description\": \"Types of payment that are supported\",\n \"enum\": [\n \"any\",\n \"cash\",\n \"cash_equivalent\",\n \"none\"\n ],\n \"title\": \"collect_on_delivery_payment_type\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"collect_on_delivery\",\n \"type\": \"object\"\n },\n \"contains_alcohol\": {\n \"default\": false,\n \"description\": \"Indicates that the shipment contains alcohol.\",\n \"type\": \"boolean\"\n },\n \"custom_field1\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_goods\": {\n \"default\": false,\n \"description\": \"Indicates if the Dangerous goods are present in the shipment\",\n \"type\": \"boolean\"\n },\n \"dangerous_goods_contact\": {\n \"description\": \"Contact information for Dangerous goods\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the contact\",\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number of the contact\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"delivered_duty_paid\": {\n \"default\": false,\n \"description\": \"Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\\n\",\n \"type\": \"boolean\"\n },\n \"delivery-as-addressed\": {\n \"default\": false,\n \"description\": \"Instructs the carrier to deliver the package only to the exact address provided.\",\n \"type\": \"boolean\"\n },\n \"dry_ice\": {\n \"default\": false,\n \"description\": \"Indicates if the shipment contain dry ice\",\n \"type\": \"boolean\"\n },\n \"dry_ice_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the dry ice in the shipment\",\n \"nullable\": true\n },\n \"fedex_freight\": {\n \"description\": \"Provide details for the Fedex freight service\",\n \"properties\": {\n \"booking_confirmation\": {\n \"type\": \"string\"\n },\n \"shipper_load_and_count\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"fragile\": {\n \"default\": false,\n \"description\": \"Indicates that the contents of the package are fragile and should be handled with care.\",\n \"type\": \"boolean\"\n },\n \"freight_class\": {\n \"default\": null,\n \"description\": \"The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \\\"77.5\\\", \\\"110\\\", or \\\"250\\\".\\n\",\n \"example\": 77.5,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"default\": null,\n \"description\": \"invoice_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": \"IOC56888\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"license_number\": {\n \"default\": null,\n \"description\": \"license_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 514785,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"non_machinable\": {\n \"default\": false,\n \"description\": \"Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\\n\",\n \"type\": \"boolean\"\n },\n \"origin_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates if the package will be picked up or dropped off by the carrier\",\n \"enum\": [\n \"pickup\",\n \"drop_off\"\n ],\n \"title\": \"origin_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"nullable\": true\n },\n \"regulated_content_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"enum\": [\n \"day_old_poultry\",\n \"other_live_animal\"\n ],\n \"title\": \"regulated_content_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"nullable\": true\n },\n \"return-after-first-attempt\": {\n \"default\": false,\n \"description\": \"Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.\",\n \"type\": \"boolean\"\n },\n \"saturday_delivery\": {\n \"default\": false,\n \"description\": \"Enables Saturday delivery, if supported by the carrier.\",\n \"type\": \"boolean\"\n },\n \"shipper_release\": {\n \"default\": null,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"third_party_consignee\": {\n \"default\": false,\n \"description\": \"Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached\",\n \"type\": \"boolean\"\n },\n \"use_ups_ground_freight_pricing\": {\n \"default\": null,\n \"description\": \"Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"windsor_framework_details\": {\n \"description\": \"The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.\",\n \"properties\": {\n \"movement_indicator\": {\n \"description\": \"An indicator that will tell the carrier and HMRC the type of movement for the shipment.\",\n \"enum\": [\n \"c2c\",\n \"b2c\",\n \"c2b\",\n \"b2b\"\n ],\n \"type\": \"string\"\n },\n \"not_at_risk\": {\n \"description\": \"An indicator that allows a shipper to declare the shipment as not-at-risk.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"title\": \"advanced_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Advanced shipment options. These are entirely optional.\"\n },\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The carrier account that is billed for the shipping charges\"\n },\n \"comparison_rate_type\": {\n \"description\": \"Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.\",\n \"example\": \"retail\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The type of delivery confirmation that is required for this shipment.\"\n },\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"customs\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Options for international shipments, such as customs declarations.\",\n \"properties\": {\n \"certificate_number\": {\n \"description\": \"The certificate number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"contents\": {\n \"allOf\": [\n {\n \"description\": \"The possible package contents values\",\n \"enum\": [\n \"merchandise\",\n \"documents\",\n \"gift\",\n \"returned_goods\",\n \"sample\",\n \"other\"\n ],\n \"title\": \"package_contents\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"merchandise\",\n \"description\": \"The type of contents in this shipment. This may impact import duties or customs treatment.\"\n },\n \"contents_explanation\": {\n \"description\": \"Explanation for contents (required if the `contents` is provided as `other`)\",\n \"type\": \"string\"\n },\n \"customs_items\": {\n \"default\": [],\n \"deprecated\": true,\n \"description\": \"Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"customs_item_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the customs item\",\n \"readOnly\": true\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the customs item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"value_currency\": {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"required\": [\n \"customs_item_id\"\n ],\n \"title\": \"customs_item\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"declaration\": {\n \"description\": \"Declaration statement to be placed on the commercial invoice\",\n \"type\": \"string\"\n },\n \"importer_of_record\": {\n \"allOf\": [\n {\n \"description\": \"importer of records address, anywhere in the world.\\n\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"postal_code\",\n \"country_code\"\n ],\n \"title\": \"importer_of_records\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"invoice_additional_details\": {\n \"allOf\": [\n {\n \"description\": \"The additional information to put on commercial invoice \\n\",\n \"properties\": {\n \"discount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Discount for shipment.\"\n },\n \"estimated_import_charges\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\\n\",\n \"properties\": {\n \"duties\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import duties.\"\n },\n \"taxes\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import taxes.\"\n }\n },\n \"title\": \"estimated_import_charges\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\"\n },\n \"freight_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Freight Charge for shipment.\"\n },\n \"insurance_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Insurance Charge for shipment.\"\n },\n \"invoice_number\": {\n \"description\": \"The invoice number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"other_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Other charge for shipment.\"\n },\n \"other_charge_description\": {\n \"description\": \"Description for the other charge (if provided).\",\n \"type\": \"string\"\n }\n },\n \"title\": \"invoice_additional_details\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"license_number\": {\n \"description\": \"The license number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"non_delivery\": {\n \"allOf\": [\n {\n \"description\": \"The possible non delivery values\",\n \"enum\": [\n \"return_to_sender\",\n \"treat_as_abandoned\"\n ],\n \"title\": \"non_delivery\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"return_to_sender\",\n \"description\": \"Indicates what to do if a package is unable to be delivered.\"\n },\n \"terms_of_trade_code\": {\n \"allOf\": [\n {\n \"enum\": [\n \"exw\",\n \"fca\",\n \"cpt\",\n \"cip\",\n \"dpu\",\n \"dap\",\n \"ddp\",\n \"fas\",\n \"fob\",\n \"cfr\",\n \"cif\",\n \"ddu\",\n \"daf\",\n \"deq\",\n \"des\"\n ],\n \"title\": \"Allowed incoterms\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Specifies the supported terms of trade code (incoterms)\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"contents\",\n \"non_delivery\"\n ],\n \"title\": \"international_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"default\": null,\n \"description\": \"Customs information. This is usually only needed for international shipments.\\n\",\n \"nullable\": true\n },\n \"external_order_id\": {\n \"description\": \"ID that the Order Source assigned\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_shipment_id\": {\n \"description\": \"A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\\n\\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"insurance_provider\": {\n \"allOf\": [\n {\n \"description\": \"The possible insurance provider values\",\n \"enum\": [\n \"none\",\n \"shipsurance\",\n \"carrier\",\n \"third_party\"\n ],\n \"title\": \"insurance_provider\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The insurance provider to use for any insured packages in the shipment.\\n\"\n },\n \"is_return\": {\n \"default\": false,\n \"description\": \"An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"items\": {\n \"default\": [],\n \"description\": \"Describe the packages included in this shipment as related to potential metadata that was imported from\\nexternal order sources\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A shipment item\",\n \"properties\": {\n \"asin\": {\n \"description\": \"Amazon Standard Identification Number\",\n \"example\": \"B00005N5PF\",\n \"maxLength\": 10,\n \"minLength\": 10,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bundle_sku\": {\n \"description\": \"Item Stock Keeping Unit of the product bundle\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"external_order_id\": {\n \"description\": \"external order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_order_item_id\": {\n \"description\": \"external order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"item name\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"quantity\": {\n \"description\": \"The quantity of this item included in the shipment\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sales_order_id\": {\n \"description\": \"sales order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sales_order_item_id\": {\n \"description\": \"sales order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku\": {\n \"description\": \"Item Stock Keeping Unit\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"shipment_item\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created or last modified.\",\n \"readOnly\": true\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"packages\": {\n \"description\": \"The packages in the shipment.\\n\\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package associated with a shipment\\n\",\n \"properties\": {\n \"content_description\": {\n \"description\": \"A short description of the package content. Required for shipments moving to, from, and through Mexico.\\n\",\n \"example\": \"Hand knitted wool socks\",\n \"maxLength\": 35,\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n },\n \"external_package_id\": {\n \"description\": \"An external package id.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"insured_value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"default\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"description\": \"The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\\n\"\n },\n \"label_messages\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\\n\\n|Carrier |Max lines |Max line length\\n|-------------------|----------|--------------------\\n|USPS (Stamps.com) |3 |60\\n|FedEx |3 |35 for the first line. 30 for additional lines.\\n|UPS |2 |35\\n|OnTrac |2 |25\\n\",\n \"properties\": {\n \"reference1\": {\n \"default\": null,\n \"description\": \"The first line of the custom label message. Some carriers may prefix this line with something like \\\"REF\\\", \\\"Reference\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference2\": {\n \"default\": null,\n \"description\": \"The second line of the custom label message. Some carriers may prefix this line with something like \\\"INV\\\", \\\"Reference 2\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference3\": {\n \"default\": null,\n \"description\": \"The third line of the custom label message. Some carriers may prefix this line with something like \\\"PO\\\", \\\"Reference 3\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"reference1\",\n \"reference2\",\n \"reference3\"\n ],\n \"title\": \"label_messages\",\n \"type\": \"object\"\n }\n ]\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\\n\"\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\"\n },\n \"package_name\": {\n \"description\": \"The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\",\n \"type\": \"string\"\n },\n \"products\": {\n \"default\": [],\n \"description\": \"Details about products inside packages (Information provided would be used on custom documentation)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"dangerous_goods\": {\n \"default\": [],\n \"description\": \"Details about dangerous goods inside products\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"Dangerous goods attribute associated with the product\\n\",\n \"properties\": {\n \"additional_description\": {\n \"default\": null,\n \"description\": \"Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_amount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"This model represents the amount of the dangerous goods..\",\n \"properties\": {\n \"amount\": {\n \"default\": 0,\n \"description\": \"The amount of dangerous goods.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"default\": null,\n \"description\": \"The unit of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_amount\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"This model represents the amount of the dangerous goods.\"\n },\n \"id_number\": {\n \"default\": null,\n \"description\": \"UN number to identify the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_group\": {\n \"enum\": [\n \"i\",\n \"ii\",\n \"iii\"\n ],\n \"title\": \"packaging_group\",\n \"type\": \"string\"\n },\n \"packaging_instruction\": {\n \"default\": null,\n \"description\": \"The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_instruction_section\": {\n \"enum\": [\n \"section_1\",\n \"section_2\",\n \"section_1a\",\n \"section_1b\"\n ],\n \"title\": \"packaging_instruction_section\",\n \"type\": \"string\"\n },\n \"packaging_type\": {\n \"default\": null,\n \"description\": \"The type of exterior packaging used to contain the dangerous good.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class\": {\n \"default\": null,\n \"description\": \"Dangerous goods product class based on regulation.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class_subsidiary\": {\n \"default\": null,\n \"description\": \"A secondary of product class for substances presenting more than one particular hazard\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"Quantity of dangerous goods.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"radioactive\": {\n \"description\": \"Indication if the substance is radioactive.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"regulation_authority\": {\n \"default\": null,\n \"description\": \"Name of the regulatory authority.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"regulation_level\": {\n \"enum\": [\n \"lightly_regulated\",\n \"fully_regulated\",\n \"limited_quantities\",\n \"excepted_quantity\"\n ],\n \"title\": \"regulation_level\",\n \"type\": \"string\"\n },\n \"reportable_quantity\": {\n \"description\": \"Indication if the substance needs to be reported to regulatory authority based on the quantity.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"shipping_name\": {\n \"default\": null,\n \"description\": \"Trade description of the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"technical_name\": {\n \"default\": null,\n \"description\": \"Recognized Technical or chemical name of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_category\": {\n \"default\": null,\n \"description\": \"Transport category assign to dangerous goods for the transport purpose.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_mean\": {\n \"enum\": [\n \"ground\",\n \"water\",\n \"cargo_aircraft_only\",\n \"passenger_aircraft\"\n ],\n \"title\": \"transport_mean\",\n \"type\": \"string\"\n },\n \"tunnel_code\": {\n \"default\": null,\n \"description\": \"Defines which types of tunnels the shipment is allowed to go through\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_goods\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"extended_details\": {\n \"additionalProperties\": true,\n \"description\": \"Additional details about products\",\n \"type\": \"object\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"mid_code\": {\n \"description\": \"Manufacturers Identification code\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_url\": {\n \"description\": \"link to the item on the seller website\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The declared value of each item\"\n },\n \"vat_rate\": {\n \"description\": \"VAT rate applicable to the item\",\n \"example\": 0.2,\n \"nullable\": true,\n \"type\": \"number\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"title\": \"products\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"shipment_package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this shipment package\",\n \"readOnly\": true\n },\n \"tracking_number\": {\n \"allOf\": [\n {\n \"description\": \"A tracking number for a package. The format depends on the carrier.\",\n \"example\": \"1Z932R800392060079\",\n \"minLength\": 1,\n \"title\": \"tracking_number\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The tracking number for the package. The format depends on the carrier.\\n\",\n \"readOnly\": true\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package weight\"\n }\n },\n \"required\": [\n \"weight\"\n ],\n \"title\": \"package\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"return_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address for this shipment. Defaults to the `ship_from` address.\\n\"\n },\n \"service_code\": {\n \"allOf\": [\n {\n \"description\": \"A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\",\n \"example\": \"usps_first_class_mail\",\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9-]+)* ?$\",\n \"title\": \"service_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\\n\",\n \"example\": \"2018-09-23T00:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}(T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2}))?$\",\n \"title\": \"date\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\\n\"\n },\n \"ship_from\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\\n\"\n },\n \"ship_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"geolocation\": {\n \"items\": {\n \"properties\": {\n \"type\": {\n \"description\": \"Enum of available type of geolocation items:\\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\\n\",\n \"enum\": [\n \"what3words\"\n ],\n \"example\": \"what3words\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"value of the geolocation item\",\n \"example\": \"cats.with.thumbs\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The recipient's mailing address\"\n },\n \"shipment_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the shipment\",\n \"readOnly\": true\n },\n \"shipment_number\": {\n \"description\": \"A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\\n\\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment_status\": {\n \"allOf\": [\n {\n \"description\": \"The possible shipment status values\",\n \"enum\": [\n \"pending\",\n \"processing\",\n \"label_purchased\",\n \"cancelled\"\n ],\n \"title\": \"shipment_status\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pending\",\n \"description\": \"The current status of the shipment\",\n \"readOnly\": true\n },\n \"shipping_rule_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\\n\"\n },\n \"tags\": {\n \"default\": [],\n \"description\": \"Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"properties\": {\n \"color\": {\n \"description\": \"A hex-coded string identifying the color of the tag.\",\n \"example\": \"#FF0000\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The tag name.\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"tag_id\": {\n \"description\": \"An integer uniquely identifying a tag.\",\n \"example\": 8712,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"title\": \"tag\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 0,\n \"readOnly\": true,\n \"type\": \"array\"\n },\n \"tax_identifiers\": {\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A tax identifier object\",\n \"properties\": {\n \"identifier_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type | Description\\n|---------------|-----------------------------------------\\n|`vat` | The tax identifier is a Value Added Tax.\\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\\n|`ssn` | The tax identifier is a Social Security Number.\\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\\n|`passport` | The tax identifier is a Passport Number.\\n|`abn` | The tax identifier is an Australian Business Number.\\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\\n\",\n \"enum\": [\n \"vat\",\n \"eori\",\n \"ssn\",\n \"ein\",\n \"tin\",\n \"ioss\",\n \"pan\",\n \"voec\",\n \"pccc\",\n \"oss\",\n \"passport\",\n \"abn\",\n \"ukims\"\n ],\n \"title\": \"identifier_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"issuing_authority\": {\n \"description\": \"The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.\",\n \"type\": \"string\"\n },\n \"taxable_entity_type\": {\n \"allOf\": [\n {\n \"description\": \"The taxable entity type for this tax item. Valid values include the following\\n\\n|Value |Description\\n|:--------- |:-----------------------------------------------------\\n|`shipper` | The shipper is responsible for this tax.\\n|`recipient` | The recipient of the shipment is responsible for this tax.\\n|`ior` | The importer of records is responsible for tax.\\n\",\n \"enum\": [\n \"shipper\",\n \"recipient\",\n \"ior\"\n ],\n \"title\": \"taxable_entity_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The value of the identifier\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"taxable_entity_type\",\n \"identifier_type\",\n \"issuing_authority\",\n \"value\"\n ],\n \"title\": \"tax_identifier\",\n \"type\": \"object\"\n }\n ]\n },\n \"nullable\": true,\n \"type\": \"array\"\n },\n \"total_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The combined weight of all packages in the shipment\",\n \"readOnly\": true\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\\n\",\n \"nullable\": true\n },\n \"zone\": {\n \"description\": \"Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\\ncustom zones that vary depending upon the ship_to and ship_from location\\n\",\n \"example\": 6,\n \"format\": \"int32\",\n \"minimum\": 0,\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"title\": \"partial_shipment\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An address validating shipment\",\n \"required\": [\n \"shipment_id\",\n \"carrier_id\",\n \"service_code\",\n \"ship_to\",\n \"ship_from\"\n ],\n \"title\": \"address_validating_shipment\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment object\"\n }\n },\n \"title\": \"rate_shipment_request\",\n \"type\": \"object\"\n }\n ],\n \"properties\": {\n \"ship_from_service_point_id\": {\n \"description\": \"A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address.\",\n \"example\": \"614940\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"ship_to_service_point_id\": {\n \"description\": \"A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address.\",\n \"example\": \"614940\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"shipment_id\",\n \"shipment\"\n ],\n \"title\": \"calculate_rates_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"calculate_rates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Shipping Rates\",\n \"tags\": [\n \"rates\"\n ]\n },\n \"cancel_label_refund\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Cancel a scheduled refund request for a label. Only labels with refund status \\\"request_scheduled\\\" can be excluded from an upcoming refund request.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"cancel_label_refund\",\n \"parameters\": [\n {\n \"description\": \"Label ID\",\n \"in\": \"path\",\n \"name\": \"label_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/{label_id}/cancel_refund\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"cancel_label_refund\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Cancel a label refund request\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"cancel_shipments\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first\\nAn example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled\\nwould remove it from this process\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"cancel_shipments\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/{shipment_id}/cancel\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"cancel_shipments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Cancel a Shipment\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"compare_bulk_rates\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Bulk Shipment Rates\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"compare_bulk_rates\",\n \"parameters\": [],\n \"path\": \"/v1/rates/bulk\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"properties\": {\n \"rate_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A rate request body\",\n \"properties\": {\n \"calculate_tax_amount\": {\n \"description\": \"Calculate the duties and tariffs for cross border shipments.\",\n \"type\": \"boolean\"\n },\n \"carrier_ids\": {\n \"description\": \"Array of carrier ids to get rates for\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"carrier ids\"\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"is_return\": {\n \"description\": \"Indicate if it's a return shipment\",\n \"type\": \"boolean\"\n },\n \"package_types\": {\n \"items\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"preferred_currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n },\n \"rate_type\": {\n \"description\": \"Indicates what type of rating to perform\",\n \"enum\": [\n \"check\",\n \"shipment\",\n \"quick\"\n ],\n \"type\": \"string\"\n },\n \"service_codes\": {\n \"items\": {\n \"description\": \"Item Service Codes\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"carrier_ids\"\n ],\n \"title\": \"rate_request_body\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The rate options\"\n }\n },\n \"title\": \"rate_request_rate_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A rate shipments request body\",\n \"oneOf\": [\n {\n \"properties\": {\n \"shipment_ids\": {\n \"description\": \"The array of shipment IDs\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"shipment ids\"\n },\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"shipment_ids\"\n ],\n \"title\": \"rate_request_by_shipment_ids\",\n \"type\": \"object\"\n },\n {\n \"properties\": {\n \"shipments\": {\n \"description\": \"The array of shipments to get bulk rate estimates for\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"properties\": {\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"no_validation\"\n }\n },\n \"title\": \"validate_shipment_fields\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\\n\",\n \"properties\": {\n \"advanced_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": true,\n \"description\": \"Advanced shipment options\",\n \"properties\": {\n \"additional_handling\": {\n \"default\": null,\n \"description\": \"Indicate to the carrier that this shipment requires additional handling.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"bill_to_account\": {\n \"default\": null,\n \"description\": \"This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bill_to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true\n },\n \"bill_to_party\": {\n \"allOf\": [\n {\n \"description\": \"The possible bill to party values\",\n \"enum\": [\n \"recipient\",\n \"third_party\"\n ],\n \"title\": \"bill_to_party\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\\n\",\n \"nullable\": true\n },\n \"bill_to_postal_code\": {\n \"default\": null,\n \"description\": \"The postal code of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"certificate_number\": {\n \"default\": null,\n \"description\": \"certificate_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 784515,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"collect_on_delivery\": {\n \"description\": \"Defer payment until package is delivered, instead of when it is ordered.\",\n \"properties\": {\n \"payment_amount\": {\n \"properties\": {\n \"amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"payment_amount\",\n \"type\": \"object\"\n },\n \"payment_type\": {\n \"allOf\": [\n {\n \"description\": \"Types of payment that are supported\",\n \"enum\": [\n \"any\",\n \"cash\",\n \"cash_equivalent\",\n \"none\"\n ],\n \"title\": \"collect_on_delivery_payment_type\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"collect_on_delivery\",\n \"type\": \"object\"\n },\n \"contains_alcohol\": {\n \"default\": false,\n \"description\": \"Indicates that the shipment contains alcohol.\",\n \"type\": \"boolean\"\n },\n \"custom_field1\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_goods\": {\n \"default\": false,\n \"description\": \"Indicates if the Dangerous goods are present in the shipment\",\n \"type\": \"boolean\"\n },\n \"dangerous_goods_contact\": {\n \"description\": \"Contact information for Dangerous goods\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the contact\",\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number of the contact\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"delivered_duty_paid\": {\n \"default\": false,\n \"description\": \"Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\\n\",\n \"type\": \"boolean\"\n },\n \"delivery-as-addressed\": {\n \"default\": false,\n \"description\": \"Instructs the carrier to deliver the package only to the exact address provided.\",\n \"type\": \"boolean\"\n },\n \"dry_ice\": {\n \"default\": false,\n \"description\": \"Indicates if the shipment contain dry ice\",\n \"type\": \"boolean\"\n },\n \"dry_ice_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the dry ice in the shipment\",\n \"nullable\": true\n },\n \"fedex_freight\": {\n \"description\": \"Provide details for the Fedex freight service\",\n \"properties\": {\n \"booking_confirmation\": {\n \"type\": \"string\"\n },\n \"shipper_load_and_count\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"fragile\": {\n \"default\": false,\n \"description\": \"Indicates that the contents of the package are fragile and should be handled with care.\",\n \"type\": \"boolean\"\n },\n \"freight_class\": {\n \"default\": null,\n \"description\": \"The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \\\"77.5\\\", \\\"110\\\", or \\\"250\\\".\\n\",\n \"example\": 77.5,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"default\": null,\n \"description\": \"invoice_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": \"IOC56888\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"license_number\": {\n \"default\": null,\n \"description\": \"license_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 514785,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"non_machinable\": {\n \"default\": false,\n \"description\": \"Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\\n\",\n \"type\": \"boolean\"\n },\n \"origin_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates if the package will be picked up or dropped off by the carrier\",\n \"enum\": [\n \"pickup\",\n \"drop_off\"\n ],\n \"title\": \"origin_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"nullable\": true\n },\n \"regulated_content_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"enum\": [\n \"day_old_poultry\",\n \"other_live_animal\"\n ],\n \"title\": \"regulated_content_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"nullable\": true\n },\n \"return-after-first-attempt\": {\n \"default\": false,\n \"description\": \"Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.\",\n \"type\": \"boolean\"\n },\n \"saturday_delivery\": {\n \"default\": false,\n \"description\": \"Enables Saturday delivery, if supported by the carrier.\",\n \"type\": \"boolean\"\n },\n \"shipper_release\": {\n \"default\": null,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"third_party_consignee\": {\n \"default\": false,\n \"description\": \"Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached\",\n \"type\": \"boolean\"\n },\n \"use_ups_ground_freight_pricing\": {\n \"default\": null,\n \"description\": \"Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"windsor_framework_details\": {\n \"description\": \"The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.\",\n \"properties\": {\n \"movement_indicator\": {\n \"description\": \"An indicator that will tell the carrier and HMRC the type of movement for the shipment.\",\n \"enum\": [\n \"c2c\",\n \"b2c\",\n \"c2b\",\n \"b2b\"\n ],\n \"type\": \"string\"\n },\n \"not_at_risk\": {\n \"description\": \"An indicator that allows a shipper to declare the shipment as not-at-risk.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"title\": \"advanced_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Advanced shipment options. These are entirely optional.\"\n },\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The carrier account that is billed for the shipping charges\"\n },\n \"comparison_rate_type\": {\n \"description\": \"Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.\",\n \"example\": \"retail\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The type of delivery confirmation that is required for this shipment.\"\n },\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"customs\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Options for international shipments, such as customs declarations.\",\n \"properties\": {\n \"certificate_number\": {\n \"description\": \"The certificate number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"contents\": {\n \"allOf\": [\n {\n \"description\": \"The possible package contents values\",\n \"enum\": [\n \"merchandise\",\n \"documents\",\n \"gift\",\n \"returned_goods\",\n \"sample\",\n \"other\"\n ],\n \"title\": \"package_contents\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"merchandise\",\n \"description\": \"The type of contents in this shipment. This may impact import duties or customs treatment.\"\n },\n \"contents_explanation\": {\n \"description\": \"Explanation for contents (required if the `contents` is provided as `other`)\",\n \"type\": \"string\"\n },\n \"customs_items\": {\n \"default\": [],\n \"deprecated\": true,\n \"description\": \"Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"customs_item_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the customs item\",\n \"readOnly\": true\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the customs item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"value_currency\": {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"required\": [\n \"customs_item_id\"\n ],\n \"title\": \"customs_item\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"declaration\": {\n \"description\": \"Declaration statement to be placed on the commercial invoice\",\n \"type\": \"string\"\n },\n \"importer_of_record\": {\n \"allOf\": [\n {\n \"description\": \"importer of records address, anywhere in the world.\\n\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"postal_code\",\n \"country_code\"\n ],\n \"title\": \"importer_of_records\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"invoice_additional_details\": {\n \"allOf\": [\n {\n \"description\": \"The additional information to put on commercial invoice \\n\",\n \"properties\": {\n \"discount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Discount for shipment.\"\n },\n \"estimated_import_charges\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\\n\",\n \"properties\": {\n \"duties\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import duties.\"\n },\n \"taxes\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import taxes.\"\n }\n },\n \"title\": \"estimated_import_charges\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\"\n },\n \"freight_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Freight Charge for shipment.\"\n },\n \"insurance_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Insurance Charge for shipment.\"\n },\n \"invoice_number\": {\n \"description\": \"The invoice number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"other_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Other charge for shipment.\"\n },\n \"other_charge_description\": {\n \"description\": \"Description for the other charge (if provided).\",\n \"type\": \"string\"\n }\n },\n \"title\": \"invoice_additional_details\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"license_number\": {\n \"description\": \"The license number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"non_delivery\": {\n \"allOf\": [\n {\n \"description\": \"The possible non delivery values\",\n \"enum\": [\n \"return_to_sender\",\n \"treat_as_abandoned\"\n ],\n \"title\": \"non_delivery\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"return_to_sender\",\n \"description\": \"Indicates what to do if a package is unable to be delivered.\"\n },\n \"terms_of_trade_code\": {\n \"allOf\": [\n {\n \"enum\": [\n \"exw\",\n \"fca\",\n \"cpt\",\n \"cip\",\n \"dpu\",\n \"dap\",\n \"ddp\",\n \"fas\",\n \"fob\",\n \"cfr\",\n \"cif\",\n \"ddu\",\n \"daf\",\n \"deq\",\n \"des\"\n ],\n \"title\": \"Allowed incoterms\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Specifies the supported terms of trade code (incoterms)\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"contents\",\n \"non_delivery\"\n ],\n \"title\": \"international_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"default\": null,\n \"description\": \"Customs information. This is usually only needed for international shipments.\\n\",\n \"nullable\": true\n },\n \"external_order_id\": {\n \"description\": \"ID that the Order Source assigned\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_shipment_id\": {\n \"description\": \"A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\\n\\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"insurance_provider\": {\n \"allOf\": [\n {\n \"description\": \"The possible insurance provider values\",\n \"enum\": [\n \"none\",\n \"shipsurance\",\n \"carrier\",\n \"third_party\"\n ],\n \"title\": \"insurance_provider\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The insurance provider to use for any insured packages in the shipment.\\n\"\n },\n \"is_return\": {\n \"default\": false,\n \"description\": \"An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"items\": {\n \"default\": [],\n \"description\": \"Describe the packages included in this shipment as related to potential metadata that was imported from\\nexternal order sources\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A shipment item\",\n \"properties\": {\n \"asin\": {\n \"description\": \"Amazon Standard Identification Number\",\n \"example\": \"B00005N5PF\",\n \"maxLength\": 10,\n \"minLength\": 10,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bundle_sku\": {\n \"description\": \"Item Stock Keeping Unit of the product bundle\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"external_order_id\": {\n \"description\": \"external order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_order_item_id\": {\n \"description\": \"external order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"item name\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"quantity\": {\n \"description\": \"The quantity of this item included in the shipment\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sales_order_id\": {\n \"description\": \"sales order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sales_order_item_id\": {\n \"description\": \"sales order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku\": {\n \"description\": \"Item Stock Keeping Unit\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"shipment_item\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created or last modified.\",\n \"readOnly\": true\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"packages\": {\n \"description\": \"The packages in the shipment.\\n\\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package associated with a shipment\\n\",\n \"properties\": {\n \"content_description\": {\n \"description\": \"A short description of the package content. Required for shipments moving to, from, and through Mexico.\\n\",\n \"example\": \"Hand knitted wool socks\",\n \"maxLength\": 35,\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n },\n \"external_package_id\": {\n \"description\": \"An external package id.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"insured_value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"default\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"description\": \"The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\\n\"\n },\n \"label_messages\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\\n\\n|Carrier |Max lines |Max line length\\n|-------------------|----------|--------------------\\n|USPS (Stamps.com) |3 |60\\n|FedEx |3 |35 for the first line. 30 for additional lines.\\n|UPS |2 |35\\n|OnTrac |2 |25\\n\",\n \"properties\": {\n \"reference1\": {\n \"default\": null,\n \"description\": \"The first line of the custom label message. Some carriers may prefix this line with something like \\\"REF\\\", \\\"Reference\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference2\": {\n \"default\": null,\n \"description\": \"The second line of the custom label message. Some carriers may prefix this line with something like \\\"INV\\\", \\\"Reference 2\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference3\": {\n \"default\": null,\n \"description\": \"The third line of the custom label message. Some carriers may prefix this line with something like \\\"PO\\\", \\\"Reference 3\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"reference1\",\n \"reference2\",\n \"reference3\"\n ],\n \"title\": \"label_messages\",\n \"type\": \"object\"\n }\n ]\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\\n\"\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\"\n },\n \"package_name\": {\n \"description\": \"The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\",\n \"type\": \"string\"\n },\n \"products\": {\n \"default\": [],\n \"description\": \"Details about products inside packages (Information provided would be used on custom documentation)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"dangerous_goods\": {\n \"default\": [],\n \"description\": \"Details about dangerous goods inside products\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"Dangerous goods attribute associated with the product\\n\",\n \"properties\": {\n \"additional_description\": {\n \"default\": null,\n \"description\": \"Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_amount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"This model represents the amount of the dangerous goods..\",\n \"properties\": {\n \"amount\": {\n \"default\": 0,\n \"description\": \"The amount of dangerous goods.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"default\": null,\n \"description\": \"The unit of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_amount\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"This model represents the amount of the dangerous goods.\"\n },\n \"id_number\": {\n \"default\": null,\n \"description\": \"UN number to identify the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_group\": {\n \"enum\": [\n \"i\",\n \"ii\",\n \"iii\"\n ],\n \"title\": \"packaging_group\",\n \"type\": \"string\"\n },\n \"packaging_instruction\": {\n \"default\": null,\n \"description\": \"The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_instruction_section\": {\n \"enum\": [\n \"section_1\",\n \"section_2\",\n \"section_1a\",\n \"section_1b\"\n ],\n \"title\": \"packaging_instruction_section\",\n \"type\": \"string\"\n },\n \"packaging_type\": {\n \"default\": null,\n \"description\": \"The type of exterior packaging used to contain the dangerous good.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class\": {\n \"default\": null,\n \"description\": \"Dangerous goods product class based on regulation.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class_subsidiary\": {\n \"default\": null,\n \"description\": \"A secondary of product class for substances presenting more than one particular hazard\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"Quantity of dangerous goods.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"radioactive\": {\n \"description\": \"Indication if the substance is radioactive.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"regulation_authority\": {\n \"default\": null,\n \"description\": \"Name of the regulatory authority.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"regulation_level\": {\n \"enum\": [\n \"lightly_regulated\",\n \"fully_regulated\",\n \"limited_quantities\",\n \"excepted_quantity\"\n ],\n \"title\": \"regulation_level\",\n \"type\": \"string\"\n },\n \"reportable_quantity\": {\n \"description\": \"Indication if the substance needs to be reported to regulatory authority based on the quantity.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"shipping_name\": {\n \"default\": null,\n \"description\": \"Trade description of the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"technical_name\": {\n \"default\": null,\n \"description\": \"Recognized Technical or chemical name of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_category\": {\n \"default\": null,\n \"description\": \"Transport category assign to dangerous goods for the transport purpose.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_mean\": {\n \"enum\": [\n \"ground\",\n \"water\",\n \"cargo_aircraft_only\",\n \"passenger_aircraft\"\n ],\n \"title\": \"transport_mean\",\n \"type\": \"string\"\n },\n \"tunnel_code\": {\n \"default\": null,\n \"description\": \"Defines which types of tunnels the shipment is allowed to go through\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_goods\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"extended_details\": {\n \"additionalProperties\": true,\n \"description\": \"Additional details about products\",\n \"type\": \"object\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"mid_code\": {\n \"description\": \"Manufacturers Identification code\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_url\": {\n \"description\": \"link to the item on the seller website\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The declared value of each item\"\n },\n \"vat_rate\": {\n \"description\": \"VAT rate applicable to the item\",\n \"example\": 0.2,\n \"nullable\": true,\n \"type\": \"number\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"title\": \"products\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"shipment_package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this shipment package\",\n \"readOnly\": true\n },\n \"tracking_number\": {\n \"allOf\": [\n {\n \"description\": \"A tracking number for a package. The format depends on the carrier.\",\n \"example\": \"1Z932R800392060079\",\n \"minLength\": 1,\n \"title\": \"tracking_number\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The tracking number for the package. The format depends on the carrier.\\n\",\n \"readOnly\": true\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package weight\"\n }\n },\n \"required\": [\n \"weight\"\n ],\n \"title\": \"package\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"return_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address for this shipment. Defaults to the `ship_from` address.\\n\"\n },\n \"service_code\": {\n \"allOf\": [\n {\n \"description\": \"A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\",\n \"example\": \"usps_first_class_mail\",\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9-]+)* ?$\",\n \"title\": \"service_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\\n\",\n \"example\": \"2018-09-23T00:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}(T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2}))?$\",\n \"title\": \"date\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\\n\"\n },\n \"ship_from\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\\n\"\n },\n \"ship_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"geolocation\": {\n \"items\": {\n \"properties\": {\n \"type\": {\n \"description\": \"Enum of available type of geolocation items:\\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\\n\",\n \"enum\": [\n \"what3words\"\n ],\n \"example\": \"what3words\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"value of the geolocation item\",\n \"example\": \"cats.with.thumbs\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The recipient's mailing address\"\n },\n \"shipment_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the shipment\",\n \"readOnly\": true\n },\n \"shipment_number\": {\n \"description\": \"A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\\n\\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment_status\": {\n \"allOf\": [\n {\n \"description\": \"The possible shipment status values\",\n \"enum\": [\n \"pending\",\n \"processing\",\n \"label_purchased\",\n \"cancelled\"\n ],\n \"title\": \"shipment_status\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pending\",\n \"description\": \"The current status of the shipment\",\n \"readOnly\": true\n },\n \"shipping_rule_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\\n\"\n },\n \"tags\": {\n \"default\": [],\n \"description\": \"Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"properties\": {\n \"color\": {\n \"description\": \"A hex-coded string identifying the color of the tag.\",\n \"example\": \"#FF0000\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The tag name.\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"tag_id\": {\n \"description\": \"An integer uniquely identifying a tag.\",\n \"example\": 8712,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"title\": \"tag\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 0,\n \"readOnly\": true,\n \"type\": \"array\"\n },\n \"tax_identifiers\": {\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A tax identifier object\",\n \"properties\": {\n \"identifier_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type | Description\\n|---------------|-----------------------------------------\\n|`vat` | The tax identifier is a Value Added Tax.\\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\\n|`ssn` | The tax identifier is a Social Security Number.\\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\\n|`passport` | The tax identifier is a Passport Number.\\n|`abn` | The tax identifier is an Australian Business Number.\\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\\n\",\n \"enum\": [\n \"vat\",\n \"eori\",\n \"ssn\",\n \"ein\",\n \"tin\",\n \"ioss\",\n \"pan\",\n \"voec\",\n \"pccc\",\n \"oss\",\n \"passport\",\n \"abn\",\n \"ukims\"\n ],\n \"title\": \"identifier_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"issuing_authority\": {\n \"description\": \"The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.\",\n \"type\": \"string\"\n },\n \"taxable_entity_type\": {\n \"allOf\": [\n {\n \"description\": \"The taxable entity type for this tax item. Valid values include the following\\n\\n|Value |Description\\n|:--------- |:-----------------------------------------------------\\n|`shipper` | The shipper is responsible for this tax.\\n|`recipient` | The recipient of the shipment is responsible for this tax.\\n|`ior` | The importer of records is responsible for tax.\\n\",\n \"enum\": [\n \"shipper\",\n \"recipient\",\n \"ior\"\n ],\n \"title\": \"taxable_entity_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The value of the identifier\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"taxable_entity_type\",\n \"identifier_type\",\n \"issuing_authority\",\n \"value\"\n ],\n \"title\": \"tax_identifier\",\n \"type\": \"object\"\n }\n ]\n },\n \"nullable\": true,\n \"type\": \"array\"\n },\n \"total_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The combined weight of all packages in the shipment\",\n \"readOnly\": true\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\\n\",\n \"nullable\": true\n },\n \"zone\": {\n \"description\": \"Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\\ncustom zones that vary depending upon the ship_to and ship_from location\\n\",\n \"example\": 6,\n \"format\": \"int32\",\n \"minimum\": 0,\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"title\": \"partial_shipment\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An address validating shipment\",\n \"required\": [\n \"shipment_id\",\n \"carrier_id\",\n \"service_code\",\n \"ship_to\",\n \"ship_from\"\n ],\n \"title\": \"address_validating_shipment\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment to get a bulk rate estimate for\"\n },\n \"minItems\": 1,\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"shipments\"\n ],\n \"title\": \"rate_request_by_shipments\",\n \"type\": \"object\"\n }\n ],\n \"properties\": {\n \"ship_from_service_point_id\": {\n \"description\": \"A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address.\",\n \"example\": \"614940\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"ship_to_service_point_id\": {\n \"description\": \"A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address.\",\n \"example\": \"614940\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"rate_options\"\n ],\n \"title\": \"compare_bulk_rates_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"compare_bulk_rates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Bulk Rates\",\n \"tags\": [\n \"rates\"\n ]\n },\n \"connect_carrier\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Connect a carrier account\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"connect_carrier\",\n \"parameters\": [\n {\n \"description\": \"The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.\",\n \"in\": \"path\",\n \"name\": \"carrier_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The shipping carriers that are supported by ShipEngine\",\n \"enum\": [\n \"access_worldwide\",\n \"amazon_buy_shipping\",\n \"amazon_shipping_uk\",\n \"apc\",\n \"asendia\",\n \"australia_post\",\n \"canada_post\",\n \"dhl_ecommerce\",\n \"dhl_express\",\n \"dhl_express_au\",\n \"dhl_express_ca\",\n \"dhl_express_uk\",\n \"dpd\",\n \"endicia\",\n \"fedex\",\n \"fedex_uk\",\n \"firstmile\",\n \"imex\",\n \"newgistics\",\n \"ontrac\",\n \"purolator_canada\",\n \"royal_mail\",\n \"rr_donnelley\",\n \"seko\",\n \"sendle\",\n \"stamps_com\",\n \"ups\",\n \"lasership\"\n ],\n \"title\": \"carrier_name\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/connections/carriers/{carrier_name}\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"An Access Worldwide account information request body\",\n \"properties\": {\n \"nickname\": {\n \"description\": \"The nickname associated with the carrier connection\",\n \"example\": \"Stamps.com\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Access Worldwide Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"username\": {\n \"description\": \"Access Worldwide Username\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"username\",\n \"password\"\n ],\n \"title\": \"connect_access_worldwide_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An Amazon account information request body\",\n \"properties\": {\n \"email\": {\n \"allOf\": [\n {\n \"description\": \"An email address.\",\n \"example\": \"john.doe@example.com\",\n \"format\": \"email\",\n \"minLength\": 1,\n \"title\": \"email\",\n \"type\": \"string\"\n }\n ]\n },\n \"merchant_seller_id\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"mws_auth_token\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname to be associated with the account connection\",\n \"example\": \"Test Amazon Buy Shipping\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"merchant_seller_id\",\n \"email\",\n \"mws_auth_token\"\n ],\n \"title\": \"connect_amazon_buy_shipping_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An Amazon Shipping UK account information request body\",\n \"properties\": {\n \"auth_code\": {\n \"description\": \"Amazon UK Shipping auth code.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"The nickname associated with the carrier connection\",\n \"example\": \"Stamps.com\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"auth_code\"\n ],\n \"title\": \"connect_amazon_shipping_uk\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An APC account information request body\",\n \"properties\": {\n \"nickname\": {\n \"description\": \"The nickname for the APC account\",\n \"example\": \"APC carrier account\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"The password for the APC account\",\n \"example\": 12345,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"username\": {\n \"description\": \"The username for the APC account\",\n \"example\": \"john_doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"username\",\n \"password\"\n ],\n \"title\": \"connect_apc_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An Asendia account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Asendia account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"api_key\": {\n \"description\": \"Asendia api_key\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"The nickname of the Asendia account\",\n \"example\": \"Asendia account\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Asendia password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"processing_location\": {\n \"description\": \"Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL'\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"sub_account_number\": {\n \"description\": \"Asendia sub account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"username\": {\n \"description\": \"Asendia username\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"account_number\",\n \"username\",\n \"password\",\n \"api_key\",\n \"processing_location\"\n ],\n \"title\": \"connect_asendia_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An Australia Post account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"api_key\": {\n \"description\": \"API key\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"api_secret\": {\n \"description\": \"API secret\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"account_number\",\n \"api_key\",\n \"api_secret\",\n \"nickname\"\n ],\n \"title\": \"connect_australia_post_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Canada Post account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Canada Post Account Number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"api_key\": {\n \"description\": \"Canada Post Account API Key\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"api_secret\": {\n \"description\": \"Canada Post Account API Secret\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"contract_id\": {\n \"description\": \"Canada Post Account Contract ID\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"api_key\",\n \"api_secret\",\n \"account_number\",\n \"contract_id\"\n ],\n \"title\": \"connect_canada_post_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A DHL Ecommerce account information request body\",\n \"properties\": {\n \"account_number\": {\n \"deprecated\": true,\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ancillary_endorsement\": {\n \"allOf\": [\n {\n \"description\": \"[Ancillary service endorsements](https://pe.usps.com/text/qsg300/Q507.htm) are used by mailers to request an addressee's new address and to provide the carrier with instructions on how to handle packages that are undeliverable as addressed.\\n\\n| Ancillary Service Endorsement | Description\\n|--------------------------------|-----------------------------------------------------\\n| `none` | No ancillary service is requested. Depending on the carrier servive, the package may be forwarded, returned, or discarded.\\n| `return_service_requested` | The package is returned to the sender. If possible, notification of the new address is is included with the returned package.\\n| `forwarding_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender.\\n| `address_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. This is similar to `forwarding_service_requested`, but different restrictions and charges may apply.\\n| `change_service_requested` | The package is discarded. If possible, notification of the new address is sent to the sender.\\n| `leave_if_no_response` |\\n\",\n \"enum\": [\n \"none\",\n \"return_service_requested\",\n \"forwarding_service_requested\",\n \"address_service_requested\",\n \"change_service_requested\",\n \"leave_if_no_response\"\n ],\n \"title\": \"ancillary_service_endorsement\",\n \"type\": \"string\"\n }\n ]\n },\n \"api_key\": {\n \"description\": \"The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account.\\n\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"api_secret\": {\n \"description\": \"The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account.\\n\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"client_id\": {\n \"description\": \"The client id\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"distribution_center\": {\n \"description\": \"The distribution center\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ftp_password\": {\n \"deprecated\": true,\n \"description\": \"FTP password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ftp_username\": {\n \"deprecated\": true,\n \"description\": \"FTP username\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"A nickname to help you identify this account\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"The account password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"pickup_number\": {\n \"description\": \"The pickup number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"registration_id\": {\n \"type\": \"string\"\n },\n \"software_name\": {\n \"type\": \"string\"\n },\n \"sold_to\": {\n \"description\": \"Sold To field\",\n \"type\": \"string\"\n },\n \"username\": {\n \"description\": \"The account username\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"client_id\",\n \"username\",\n \"password\",\n \"pickup_number\",\n \"distribution_center\"\n ],\n \"title\": \"connect_dhl_ecommerce_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A DHL express account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Required if site id is provided\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"site_id\": {\n \"description\": \"Required if password is provided\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"account_number\"\n ],\n \"title\": \"connect_dhl_express_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A DHL Express AU account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"account_number\"\n ],\n \"title\": \"connect_dhl_express_au_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A DHL Express CA account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"account_number\"\n ],\n \"title\": \"connect_dhl_express_ca_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A DHL Express UK account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"site_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the site\"\n }\n },\n \"required\": [\n \"account_number\",\n \"site_id\",\n \"password\",\n \"nickname\"\n ],\n \"title\": \"connect_dhl_express_uk_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A DPD account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"account_number\",\n \"password\",\n \"nickname\"\n ],\n \"title\": \"connect_dpd_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An Endicia account information request body\",\n \"properties\": {\n \"account\": {\n \"description\": \"Account\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"passphrase\": {\n \"description\": \"Passphrase\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"account\",\n \"passphrase\"\n ],\n \"title\": \"connect_endicia_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Fedex account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address1\": {\n \"description\": \"Address\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address2\": {\n \"description\": \"Address\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"agree_to_eula\": {\n \"description\": \"Boolean signaling agreement to the Fedex End User License Agreement\",\n \"type\": \"boolean\"\n },\n \"city\": {\n \"description\": \"The city\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company\": {\n \"description\": \"The company\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"description\": \"Country code\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"email\": {\n \"allOf\": [\n {\n \"description\": \"An email address.\",\n \"example\": \"john.doe@example.com\",\n \"format\": \"email\",\n \"minLength\": 1,\n \"title\": \"email\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The email address\"\n },\n \"first_name\": {\n \"description\": \"First name\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"last_name\": {\n \"description\": \"Last name\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"meter_number\": {\n \"description\": \"Meter number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"description\": \"Postal Code\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"state\": {\n \"description\": \"State\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"account_number\",\n \"address1\",\n \"city\",\n \"country_code\",\n \"email\",\n \"first_name\",\n \"last_name\",\n \"phone\",\n \"postal_code\",\n \"state\",\n \"nickname\",\n \"agree_to_eula\"\n ],\n \"title\": \"connect_fedex_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Fedex UK account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address1\": {\n \"description\": \"Address\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address2\": {\n \"description\": \"Address\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"agree_to_eula\": {\n \"description\": \"Boolean signaling agreement to the Fedex End User License Agreement\",\n \"type\": \"boolean\"\n },\n \"city\": {\n \"description\": \"The city\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company\": {\n \"description\": \"The company\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"description\": \"Country code\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"email\": {\n \"allOf\": [\n {\n \"description\": \"An email address.\",\n \"example\": \"john.doe@example.com\",\n \"format\": \"email\",\n \"minLength\": 1,\n \"title\": \"email\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The email address\"\n },\n \"first_name\": {\n \"description\": \"First name\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"last_name\": {\n \"description\": \"Last name\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"meter_number\": {\n \"description\": \"Meter number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"description\": \"Postal Code\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"state\": {\n \"description\": \"State\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"account_number\",\n \"address1\",\n \"city\",\n \"country_code\",\n \"email\",\n \"first_name\",\n \"last_name\",\n \"phone\",\n \"postal_code\",\n \"state\",\n \"nickname\",\n \"agree_to_eula\"\n ],\n \"title\": \"connect_fedex_uk_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A First Mile account information request body\",\n \"properties\": {\n \"mailer_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the mailer\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"profile_name\": {\n \"description\": \"Profile name\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"mailer_id\",\n \"password\"\n ],\n \"title\": \"connect_firstmile_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An Imex account information request body\",\n \"properties\": {\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"username\": {\n \"description\": \"Username\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"username\",\n \"password\"\n ],\n \"title\": \"connect_imex_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Lasership account information request body\",\n \"properties\": {\n \"Address\": {\n \"description\": \"Address\",\n \"type\": \"string,\"\n },\n \"Address2\": {\n \"description\": \"Address2\",\n \"type\": \"string,\"\n },\n \"AttrAlcohol\": {\n \"description\": \"Set this to true if your shipments will always contain Alcohol\",\n \"type\": \"boolean,\"\n },\n \"AttrControlledSubstance\": {\n \"description\": \"Set this to true if your shipments will always contain Controlled Substances\",\n \"type\": \"boolean,\"\n },\n \"AttrDryIce\": {\n \"description\": \"Set this to true if your shipments will always contain DryIce\",\n \"type\": \"boolean,\"\n },\n \"AttrExplosive\": {\n \"description\": \"Set this to true if your shipments will always contain Explosives\",\n \"type\": \"boolean,\"\n },\n \"AttrHazmat\": {\n \"description\": \"Set this to true if your shipments will always contain Hazmat\",\n \"type\": \"boolean,\"\n },\n \"AttrNoRTS\": {\n \"description\": \"Set this to true if your shipments will always use \\\"No Return To Sender\\\"\",\n \"type\": \"boolean,\"\n },\n \"AttrPerishable\": {\n \"description\": \"Set this to true if your shipments will always be Perishable\",\n \"type\": \"boolean,\"\n },\n \"AttrRefrigerated\": {\n \"description\": \"Set this to true if your shipments will always require Refrigeration\",\n \"type\": \"boolean,\"\n },\n \"AttrTwoPersons\": {\n \"description\": \"Set this to true if your shipments will always require Two Persons\",\n \"type\": \"boolean,\"\n },\n \"City\": {\n \"description\": \"City\",\n \"type\": \"string,\"\n },\n \"Email\": {\n \"description\": \"Email\",\n \"type\": \"string,\"\n },\n \"Phone\": {\n \"description\": \"Phone\",\n \"type\": \"string,\"\n },\n \"PostalCode\": {\n \"description\": \"PostalCode\",\n \"type\": \"string,\"\n },\n \"State\": {\n \"description\": \"State\",\n \"type\": \"string,\"\n },\n \"country\": {\n \"description\": \"Country\",\n \"type\": \"string,\"\n },\n \"customer_branch\": {\n \"description\": \"Customer Branch\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"declare_piece_attributes_separately_for_every_shipment\": {\n \"default\": false,\n \"description\": \"Declare piece attributes separately for every shipment, overrides individual attribute below.\",\n \"type\": \"boolean,\"\n },\n \"facility_code\": {\n \"description\": \"Facility Code\",\n \"type\": \"string,\"\n },\n \"instructions\": {\n \"description\": \"Instructions\",\n \"type\": \"string,\"\n },\n \"lasership_critical_entry_time\": {\n \"description\": \"Critical Entry Time (local time)\",\n \"type\": \"string,\"\n },\n \"lasership_critical_pull_time\": {\n \"description\": \"Critical Pull Time (local time)\",\n \"type\": \"string,\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"web_services_id\": {\n \"description\": \"Web Service ID (WSID)\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"web_services_key\": {\n \"description\": \"Web Service Key (WSKey)\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"web_services_id\",\n \"web_services_key\",\n \"customer_branch\",\n \"Address\",\n \"PostalCode\",\n \"City\",\n \"State\",\n \"lasership_critical_pull_time\",\n \"lasership_critical_entry_time\"\n ],\n \"title\": \"connect_lasership_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Newgistics account information request body\",\n \"properties\": {\n \"induction_site\": {\n \"description\": \"Induction site\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"mailer_id\": {\n \"description\": \"Mailer id\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"merchant_id\": {\n \"description\": \"Merchant id\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"induction_site\",\n \"nickname\"\n ],\n \"title\": \"connect_newgistics_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An Ontrac account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"account_number\",\n \"password\"\n ],\n \"title\": \"connect_ontrac_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Purolator account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"activation_key\": {\n \"description\": \"Activation key\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"account_number\",\n \"activation_key\",\n \"nickname\"\n ],\n \"title\": \"connect_purolator_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Royal Mail account information request body\",\n \"properties\": {\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"city\": {\n \"description\": \"City\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"Company name\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"contact_name\": {\n \"description\": \"Contact name\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"email\": {\n \"allOf\": [\n {\n \"description\": \"An email address.\",\n \"example\": \"john.doe@example.com\",\n \"format\": \"email\",\n \"minLength\": 1,\n \"title\": \"email\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The email address\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"oba_email\": {\n \"allOf\": [\n {\n \"description\": \"An email address.\",\n \"example\": \"john.doe@example.com\",\n \"format\": \"email\",\n \"minLength\": 1,\n \"title\": \"email\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The oba email address\"\n },\n \"phone\": {\n \"description\": \"Phone\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"description\": \"Postal code\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"street_line1\": {\n \"description\": \"Street line1\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"street_line2\": {\n \"description\": \"Street line2\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"street_line3\": {\n \"description\": \"Street line3\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"account_number\",\n \"contact_name\",\n \"city\",\n \"postal_code\",\n \"nickname\"\n ],\n \"title\": \"connect_royal_mail_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A RR Donnelley account information request body\",\n \"properties\": {\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"username\": {\n \"description\": \"Username\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"username\",\n \"password\"\n ],\n \"title\": \"connect_rr_donnelley_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A SEKO account information request body\",\n \"properties\": {\n \"access_key\": {\n \"description\": \"Seko Account Access Key\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"access_key\"\n ],\n \"title\": \"connect_seko_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Sendle account information request body\",\n \"properties\": {\n \"api_key\": {\n \"description\": \"API key\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"sendle_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the sendle\"\n }\n },\n \"required\": [\n \"nickname\",\n \"sendle_id\",\n \"api_key\"\n ],\n \"title\": \"connect_sendle_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A Stamps account information request body\",\n \"properties\": {\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"password\": {\n \"description\": \"Password\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"username\": {\n \"description\": \"Username\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"username\",\n \"password\"\n ],\n \"title\": \"connect_stamps_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A UPS account information request body. The location header from this call should be used to redirect to UPS for sign in.\",\n \"properties\": {\n \"account_country_code\": {\n \"description\": \"Account Country Code\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"account_number\": {\n \"description\": \"Account number\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"account_postal_code\": {\n \"description\": \"Account Postal Code\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"nickname\",\n \"account_number\",\n \"account_postal_code\",\n \"account_country_code\"\n ],\n \"title\": \"connect_ups_request_body\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"connect_carrier_request_body\"\n },\n \"security\": null,\n \"skill_name\": \"connect_carrier\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Connect a carrier account\",\n \"tags\": [\n \"carrier_accounts\"\n ]\n },\n \"connect_insurer\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Connect a Shipsurance Account\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"connect_insurer\",\n \"parameters\": [],\n \"path\": \"/v1/connections/insurance/shipsurance\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A create shipsurance connection request body\",\n \"properties\": {\n \"email\": {\n \"allOf\": [\n {\n \"description\": \"An email address.\",\n \"example\": \"john.doe@example.com\",\n \"format\": \"email\",\n \"minLength\": 1,\n \"title\": \"email\",\n \"type\": \"string\"\n }\n ]\n },\n \"policy_id\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"email\",\n \"policy_id\"\n ],\n \"title\": \"connect_insurer_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"connect_insurer\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Connect a Shipsurance Account\",\n \"tags\": [\n \"insurance\"\n ]\n },\n \"create_account_image\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create an Account Image\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_account_image\",\n \"parameters\": [],\n \"path\": \"/v1/account/settings/images\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A ShipEngine account images body\",\n \"properties\": {\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the image was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"image_content_type\": {\n \"allOf\": [\n {\n \"description\": \"The image type\",\n \"enum\": [\n \"image/png\",\n \"image/jpeg\"\n ],\n \"type\": \"string\"\n }\n ],\n \"description\": \"The file type of the image. \\n\"\n },\n \"image_data\": {\n \"description\": \"A base64 encoded string representation of the image.\\n\",\n \"example\": \"iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==\",\n \"type\": \"string\"\n },\n \"is_default\": {\n \"description\": \"Indicates whether this image is set as default.\\n\",\n \"example\": false,\n \"type\": \"boolean\"\n },\n \"label_image_id\": {\n \"allOf\": [\n {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\\n\",\n \"readOnly\": true\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the image was modified in ShipEngine.\",\n \"readOnly\": true\n },\n \"name\": {\n \"description\": \"A human readable name for the image.\\n\",\n \"example\": \"My logo\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"account_settings_images\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A ShipEngine account settings images request body\",\n \"required\": [\n \"name\",\n \"image_content_type\",\n \"image_data\"\n ],\n \"title\": \"create_account_settings_image_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_account_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create an Account Image\",\n \"tags\": [\n \"account\"\n ]\n },\n \"create_batch\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create a Batch\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_batch\",\n \"parameters\": [],\n \"path\": \"/v1/batches\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A create batch request body\",\n \"properties\": {\n \"batch_notes\": {\n \"description\": \"Add custom messages for a particular batch\",\n \"example\": \"This is my batch\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"external_batch_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the external batch\"\n },\n \"rate_ids\": {\n \"description\": \"Array of rate IDs used in the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"shipment_ids\": {\n \"description\": \"Array of shipment IDs used in the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ]\n },\n \"type\": \"array\"\n }\n },\n \"title\": \"create_batch_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A create and process batch request body\",\n \"properties\": {\n \"batch_notes\": {\n \"description\": \"Add custom messages for a particular batch\",\n \"example\": \"This is my batch\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"external_batch_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the external batch\"\n },\n \"process_labels\": {\n \"description\": \"The information used to process the batch\",\n \"properties\": {\n \"create_batch_and_process_labels\": {\n \"description\": \"When 'true', the batch will be enqueued for processing\",\n \"type\": \"boolean\"\n },\n \"display_scheme\": {\n \"allOf\": [\n {\n \"description\": \"The display format that the label should be shown in.\",\n \"enum\": [\n \"label\",\n \"paperless\",\n \"label_and_paperless\"\n ],\n \"title\": \"display_scheme\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"label\",\n \"description\": \"The display format that the label should be shown in.\"\n },\n \"label_format\": {\n \"allOf\": [\n {\n \"description\": \"The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\\n|Label Format | Supported Carriers\\n|--------------|-----------------------------------\\n|`pdf` | All carriers\\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\\n\",\n \"enum\": [\n \"pdf\",\n \"png\",\n \"zpl\"\n ],\n \"title\": \"label_format\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pdf\"\n },\n \"label_layout\": {\n \"allOf\": [\n {\n \"description\": \"The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\",\n \"enum\": [\n \"4x6\",\n \"letter\",\n \"A4\",\n \"A6\"\n ],\n \"title\": \"label_layout\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"4x6\",\n \"type\": \"string\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The Ship date the batch is being processed for\"\n }\n },\n \"type\": \"object\"\n },\n \"rate_ids\": {\n \"description\": \"Array of rate IDs used in the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"shipment_ids\": {\n \"description\": \"Array of shipment IDs used in the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ]\n },\n \"type\": \"array\"\n }\n },\n \"title\": \"create_and_process_batch_request_body\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"create_batch_request\"\n },\n \"security\": null,\n \"skill_name\": \"create_batch\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create A Batch\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"create_combined_label_document\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Download a combined label file\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_combined_label_document\",\n \"parameters\": [],\n \"path\": \"/v1/documents/combined_labels\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A create combined label document request body\",\n \"properties\": {\n \"label_download_type\": {\n \"allOf\": [\n {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inline\"\n },\n \"label_format\": {\n \"description\": \"The file format for the combined label document; note that currently only `\\\"pdf\\\"` is supported.\",\n \"enum\": [\n \"pdf\"\n ],\n \"type\": \"string\"\n },\n \"label_ids\": {\n \"description\": \"The list of up to 30 label ids to include in the combined label document.\\nNote that to avoid response size limits, you should only expect to be able to combine 30 single page labels similar in size to that of USPS labels.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ]\n },\n \"type\": \"array\"\n }\n },\n \"title\": \"create_combined_label_document_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_combined_label_document\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Created Combined Label Document\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"create_label\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Purchase and print a label for shipment\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_label\",\n \"parameters\": [],\n \"path\": \"/v1/labels\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A label represents the physical sticker that you affix to a package to ship it. ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them.\\n\",\n \"properties\": {\n \"charge_event\": {\n \"allOf\": [\n {\n \"description\": \"Determines when the user's account will be charged for the label.\",\n \"enum\": [\n \"carrier_default\",\n \"on_creation\",\n \"on_carrier_acceptance\"\n ],\n \"title\": \"label_charge_event\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The label charge event.\\n\"\n },\n \"display_scheme\": {\n \"allOf\": [\n {\n \"description\": \"The display format that the label should be shown in.\",\n \"enum\": [\n \"label\",\n \"paperless\",\n \"label_and_paperless\"\n ],\n \"title\": \"display_scheme\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"label\",\n \"description\": \"The display format that the label should be shown in.\"\n },\n \"is_return_label\": {\n \"description\": \"Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned.\\n\",\n \"type\": \"boolean\"\n },\n \"label_download_type\": {\n \"allOf\": [\n {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"url\",\n \"writeOnly\": true\n },\n \"label_format\": {\n \"allOf\": [\n {\n \"description\": \"The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\\n|Label Format | Supported Carriers\\n|--------------|-----------------------------------\\n|`pdf` | All carriers\\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\\n\",\n \"enum\": [\n \"pdf\",\n \"png\",\n \"zpl\"\n ],\n \"title\": \"label_format\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pdf\",\n \"description\": \"The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\"\n },\n \"label_image_id\": {\n \"allOf\": [\n {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The label image resource that was used to create a custom label image.\",\n \"nullable\": true\n },\n \"label_layout\": {\n \"allOf\": [\n {\n \"description\": \"The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\",\n \"enum\": [\n \"4x6\",\n \"letter\",\n \"A4\",\n \"A6\"\n ],\n \"title\": \"label_layout\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"4x6\",\n \"description\": \"The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\"\n },\n \"outbound_label_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is\\nrequired by some carriers.\\n\",\n \"writeOnly\": true\n },\n \"rma_number\": {\n \"description\": \"An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\\n\\n> **Note:** Either `ship_from` or `warehouse_id` must be set.\\n\",\n \"properties\": {\n \"advanced_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": true,\n \"description\": \"Advanced shipment options\",\n \"properties\": {\n \"additional_handling\": {\n \"default\": null,\n \"description\": \"Indicate to the carrier that this shipment requires additional handling.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"bill_to_account\": {\n \"default\": null,\n \"description\": \"This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bill_to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true\n },\n \"bill_to_party\": {\n \"allOf\": [\n {\n \"description\": \"The possible bill to party values\",\n \"enum\": [\n \"recipient\",\n \"third_party\"\n ],\n \"title\": \"bill_to_party\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\\n\",\n \"nullable\": true\n },\n \"bill_to_postal_code\": {\n \"default\": null,\n \"description\": \"The postal code of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"certificate_number\": {\n \"default\": null,\n \"description\": \"certificate_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 784515,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"collect_on_delivery\": {\n \"description\": \"Defer payment until package is delivered, instead of when it is ordered.\",\n \"properties\": {\n \"payment_amount\": {\n \"properties\": {\n \"amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"payment_amount\",\n \"type\": \"object\"\n },\n \"payment_type\": {\n \"allOf\": [\n {\n \"description\": \"Types of payment that are supported\",\n \"enum\": [\n \"any\",\n \"cash\",\n \"cash_equivalent\",\n \"none\"\n ],\n \"title\": \"collect_on_delivery_payment_type\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"collect_on_delivery\",\n \"type\": \"object\"\n },\n \"contains_alcohol\": {\n \"default\": false,\n \"description\": \"Indicates that the shipment contains alcohol.\",\n \"type\": \"boolean\"\n },\n \"custom_field1\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_goods\": {\n \"default\": false,\n \"description\": \"Indicates if the Dangerous goods are present in the shipment\",\n \"type\": \"boolean\"\n },\n \"dangerous_goods_contact\": {\n \"description\": \"Contact information for Dangerous goods\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the contact\",\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number of the contact\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"delivered_duty_paid\": {\n \"default\": false,\n \"description\": \"Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\\n\",\n \"type\": \"boolean\"\n },\n \"delivery-as-addressed\": {\n \"default\": false,\n \"description\": \"Instructs the carrier to deliver the package only to the exact address provided.\",\n \"type\": \"boolean\"\n },\n \"dry_ice\": {\n \"default\": false,\n \"description\": \"Indicates if the shipment contain dry ice\",\n \"type\": \"boolean\"\n },\n \"dry_ice_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the dry ice in the shipment\",\n \"nullable\": true\n },\n \"fedex_freight\": {\n \"description\": \"Provide details for the Fedex freight service\",\n \"properties\": {\n \"booking_confirmation\": {\n \"type\": \"string\"\n },\n \"shipper_load_and_count\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"fragile\": {\n \"default\": false,\n \"description\": \"Indicates that the contents of the package are fragile and should be handled with care.\",\n \"type\": \"boolean\"\n },\n \"freight_class\": {\n \"default\": null,\n \"description\": \"The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \\\"77.5\\\", \\\"110\\\", or \\\"250\\\".\\n\",\n \"example\": 77.5,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"default\": null,\n \"description\": \"invoice_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": \"IOC56888\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"license_number\": {\n \"default\": null,\n \"description\": \"license_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 514785,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"non_machinable\": {\n \"default\": false,\n \"description\": \"Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\\n\",\n \"type\": \"boolean\"\n },\n \"origin_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates if the package will be picked up or dropped off by the carrier\",\n \"enum\": [\n \"pickup\",\n \"drop_off\"\n ],\n \"title\": \"origin_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"nullable\": true\n },\n \"regulated_content_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"enum\": [\n \"day_old_poultry\",\n \"other_live_animal\"\n ],\n \"title\": \"regulated_content_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"nullable\": true\n },\n \"return-after-first-attempt\": {\n \"default\": false,\n \"description\": \"Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.\",\n \"type\": \"boolean\"\n },\n \"saturday_delivery\": {\n \"default\": false,\n \"description\": \"Enables Saturday delivery, if supported by the carrier.\",\n \"type\": \"boolean\"\n },\n \"shipper_release\": {\n \"default\": null,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"third_party_consignee\": {\n \"default\": false,\n \"description\": \"Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached\",\n \"type\": \"boolean\"\n },\n \"use_ups_ground_freight_pricing\": {\n \"default\": null,\n \"description\": \"Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"windsor_framework_details\": {\n \"description\": \"The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.\",\n \"properties\": {\n \"movement_indicator\": {\n \"description\": \"An indicator that will tell the carrier and HMRC the type of movement for the shipment.\",\n \"enum\": [\n \"c2c\",\n \"b2c\",\n \"c2b\",\n \"b2b\"\n ],\n \"type\": \"string\"\n },\n \"not_at_risk\": {\n \"description\": \"An indicator that allows a shipper to declare the shipment as not-at-risk.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"title\": \"advanced_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Advanced shipment options. These are entirely optional.\"\n },\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The carrier account that is billed for the shipping charges\"\n },\n \"comparison_rate_type\": {\n \"description\": \"Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.\",\n \"example\": \"retail\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The type of delivery confirmation that is required for this shipment.\"\n },\n \"customs\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Options for international shipments, such as customs declarations.\",\n \"properties\": {\n \"certificate_number\": {\n \"description\": \"The certificate number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"contents\": {\n \"allOf\": [\n {\n \"description\": \"The possible package contents values\",\n \"enum\": [\n \"merchandise\",\n \"documents\",\n \"gift\",\n \"returned_goods\",\n \"sample\",\n \"other\"\n ],\n \"title\": \"package_contents\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"merchandise\",\n \"description\": \"The type of contents in this shipment. This may impact import duties or customs treatment.\"\n },\n \"contents_explanation\": {\n \"description\": \"Explanation for contents (required if the `contents` is provided as `other`)\",\n \"type\": \"string\"\n },\n \"customs_items\": {\n \"default\": [],\n \"deprecated\": true,\n \"description\": \"Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"customs_item_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the customs item\",\n \"readOnly\": true\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the customs item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"value_currency\": {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"required\": [\n \"customs_item_id\"\n ],\n \"title\": \"customs_item\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"declaration\": {\n \"description\": \"Declaration statement to be placed on the commercial invoice\",\n \"type\": \"string\"\n },\n \"importer_of_record\": {\n \"allOf\": [\n {\n \"description\": \"importer of records address, anywhere in the world.\\n\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"postal_code\",\n \"country_code\"\n ],\n \"title\": \"importer_of_records\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"invoice_additional_details\": {\n \"allOf\": [\n {\n \"description\": \"The additional information to put on commercial invoice \\n\",\n \"properties\": {\n \"discount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Discount for shipment.\"\n },\n \"estimated_import_charges\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\\n\",\n \"properties\": {\n \"duties\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import duties.\"\n },\n \"taxes\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import taxes.\"\n }\n },\n \"title\": \"estimated_import_charges\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\"\n },\n \"freight_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Freight Charge for shipment.\"\n },\n \"insurance_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Insurance Charge for shipment.\"\n },\n \"invoice_number\": {\n \"description\": \"The invoice number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"other_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Other charge for shipment.\"\n },\n \"other_charge_description\": {\n \"description\": \"Description for the other charge (if provided).\",\n \"type\": \"string\"\n }\n },\n \"title\": \"invoice_additional_details\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"license_number\": {\n \"description\": \"The license number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"non_delivery\": {\n \"allOf\": [\n {\n \"description\": \"The possible non delivery values\",\n \"enum\": [\n \"return_to_sender\",\n \"treat_as_abandoned\"\n ],\n \"title\": \"non_delivery\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"return_to_sender\",\n \"description\": \"Indicates what to do if a package is unable to be delivered.\"\n },\n \"terms_of_trade_code\": {\n \"allOf\": [\n {\n \"enum\": [\n \"exw\",\n \"fca\",\n \"cpt\",\n \"cip\",\n \"dpu\",\n \"dap\",\n \"ddp\",\n \"fas\",\n \"fob\",\n \"cfr\",\n \"cif\",\n \"ddu\",\n \"daf\",\n \"deq\",\n \"des\"\n ],\n \"title\": \"Allowed incoterms\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Specifies the supported terms of trade code (incoterms)\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"contents\",\n \"non_delivery\"\n ],\n \"title\": \"international_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"default\": null,\n \"description\": \"Customs information. This is usually only needed for international shipments.\\n\",\n \"nullable\": true\n },\n \"external_order_id\": {\n \"description\": \"ID that the Order Source assigned\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_shipment_id\": {\n \"description\": \"A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\\n\\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"insurance_provider\": {\n \"allOf\": [\n {\n \"description\": \"The possible insurance provider values\",\n \"enum\": [\n \"none\",\n \"shipsurance\",\n \"carrier\",\n \"third_party\"\n ],\n \"title\": \"insurance_provider\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The insurance provider to use for any insured packages in the shipment.\\n\"\n },\n \"is_return\": {\n \"default\": false,\n \"description\": \"An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"items\": {\n \"default\": [],\n \"description\": \"Describe the packages included in this shipment as related to potential metadata that was imported from\\nexternal order sources\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A shipment item\",\n \"properties\": {\n \"asin\": {\n \"description\": \"Amazon Standard Identification Number\",\n \"example\": \"B00005N5PF\",\n \"maxLength\": 10,\n \"minLength\": 10,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bundle_sku\": {\n \"description\": \"Item Stock Keeping Unit of the product bundle\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"external_order_id\": {\n \"description\": \"external order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_order_item_id\": {\n \"description\": \"external order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"item name\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"quantity\": {\n \"description\": \"The quantity of this item included in the shipment\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sales_order_id\": {\n \"description\": \"sales order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sales_order_item_id\": {\n \"description\": \"sales order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku\": {\n \"description\": \"Item Stock Keeping Unit\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"shipment_item\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"packages\": {\n \"description\": \"The packages in the shipment.\\n\\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package associated with a shipment\\n\",\n \"properties\": {\n \"content_description\": {\n \"description\": \"A short description of the package content. Required for shipments moving to, from, and through Mexico.\\n\",\n \"example\": \"Hand knitted wool socks\",\n \"maxLength\": 35,\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n },\n \"external_package_id\": {\n \"description\": \"An external package id.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"insured_value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"default\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"description\": \"The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\\n\"\n },\n \"label_messages\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\\n\\n|Carrier |Max lines |Max line length\\n|-------------------|----------|--------------------\\n|USPS (Stamps.com) |3 |60\\n|FedEx |3 |35 for the first line. 30 for additional lines.\\n|UPS |2 |35\\n|OnTrac |2 |25\\n\",\n \"properties\": {\n \"reference1\": {\n \"default\": null,\n \"description\": \"The first line of the custom label message. Some carriers may prefix this line with something like \\\"REF\\\", \\\"Reference\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference2\": {\n \"default\": null,\n \"description\": \"The second line of the custom label message. Some carriers may prefix this line with something like \\\"INV\\\", \\\"Reference 2\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference3\": {\n \"default\": null,\n \"description\": \"The third line of the custom label message. Some carriers may prefix this line with something like \\\"PO\\\", \\\"Reference 3\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"reference1\",\n \"reference2\",\n \"reference3\"\n ],\n \"title\": \"label_messages\",\n \"type\": \"object\"\n }\n ]\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\\n\"\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\"\n },\n \"package_name\": {\n \"description\": \"The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\",\n \"type\": \"string\"\n },\n \"products\": {\n \"default\": [],\n \"description\": \"Details about products inside packages (Information provided would be used on custom documentation)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"dangerous_goods\": {\n \"default\": [],\n \"description\": \"Details about dangerous goods inside products\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"Dangerous goods attribute associated with the product\\n\",\n \"properties\": {\n \"additional_description\": {\n \"default\": null,\n \"description\": \"Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_amount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"This model represents the amount of the dangerous goods..\",\n \"properties\": {\n \"amount\": {\n \"default\": 0,\n \"description\": \"The amount of dangerous goods.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"default\": null,\n \"description\": \"The unit of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_amount\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"This model represents the amount of the dangerous goods.\"\n },\n \"id_number\": {\n \"default\": null,\n \"description\": \"UN number to identify the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_group\": {\n \"enum\": [\n \"i\",\n \"ii\",\n \"iii\"\n ],\n \"title\": \"packaging_group\",\n \"type\": \"string\"\n },\n \"packaging_instruction\": {\n \"default\": null,\n \"description\": \"The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_instruction_section\": {\n \"enum\": [\n \"section_1\",\n \"section_2\",\n \"section_1a\",\n \"section_1b\"\n ],\n \"title\": \"packaging_instruction_section\",\n \"type\": \"string\"\n },\n \"packaging_type\": {\n \"default\": null,\n \"description\": \"The type of exterior packaging used to contain the dangerous good.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class\": {\n \"default\": null,\n \"description\": \"Dangerous goods product class based on regulation.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class_subsidiary\": {\n \"default\": null,\n \"description\": \"A secondary of product class for substances presenting more than one particular hazard\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"Quantity of dangerous goods.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"radioactive\": {\n \"description\": \"Indication if the substance is radioactive.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"regulation_authority\": {\n \"default\": null,\n \"description\": \"Name of the regulatory authority.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"regulation_level\": {\n \"enum\": [\n \"lightly_regulated\",\n \"fully_regulated\",\n \"limited_quantities\",\n \"excepted_quantity\"\n ],\n \"title\": \"regulation_level\",\n \"type\": \"string\"\n },\n \"reportable_quantity\": {\n \"description\": \"Indication if the substance needs to be reported to regulatory authority based on the quantity.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"shipping_name\": {\n \"default\": null,\n \"description\": \"Trade description of the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"technical_name\": {\n \"default\": null,\n \"description\": \"Recognized Technical or chemical name of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_category\": {\n \"default\": null,\n \"description\": \"Transport category assign to dangerous goods for the transport purpose.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_mean\": {\n \"enum\": [\n \"ground\",\n \"water\",\n \"cargo_aircraft_only\",\n \"passenger_aircraft\"\n ],\n \"title\": \"transport_mean\",\n \"type\": \"string\"\n },\n \"tunnel_code\": {\n \"default\": null,\n \"description\": \"Defines which types of tunnels the shipment is allowed to go through\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_goods\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"extended_details\": {\n \"additionalProperties\": true,\n \"description\": \"Additional details about products\",\n \"type\": \"object\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"mid_code\": {\n \"description\": \"Manufacturers Identification code\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_url\": {\n \"description\": \"link to the item on the seller website\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The declared value of each item\"\n },\n \"vat_rate\": {\n \"description\": \"VAT rate applicable to the item\",\n \"example\": 0.2,\n \"nullable\": true,\n \"type\": \"number\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"title\": \"products\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"shipment_package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this shipment package\",\n \"readOnly\": true\n },\n \"tracking_number\": {\n \"allOf\": [\n {\n \"description\": \"A tracking number for a package. The format depends on the carrier.\",\n \"example\": \"1Z932R800392060079\",\n \"minLength\": 1,\n \"title\": \"tracking_number\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The tracking number for the package. The format depends on the carrier.\\n\",\n \"readOnly\": true\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package weight\"\n }\n },\n \"required\": [\n \"weight\"\n ],\n \"title\": \"package\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"return_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address for this shipment. Defaults to the `ship_from` address.\\n\"\n },\n \"service_code\": {\n \"allOf\": [\n {\n \"description\": \"A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\",\n \"example\": \"usps_first_class_mail\",\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9-]+)* ?$\",\n \"title\": \"service_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\\n\",\n \"example\": \"2018-09-23T00:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}(T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2}))?$\",\n \"title\": \"date\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\\n\"\n },\n \"ship_from\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"required\": [\n \"phone\",\n \"country_code\"\n ],\n \"title\": \"shipping_address_from\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\\n\"\n },\n \"ship_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"geolocation\": {\n \"items\": {\n \"properties\": {\n \"type\": {\n \"description\": \"Enum of available type of geolocation items:\\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\\n\",\n \"enum\": [\n \"what3words\"\n ],\n \"example\": \"what3words\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"value of the geolocation item\",\n \"example\": \"cats.with.thumbs\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The recipient's mailing address\"\n },\n \"shipment_number\": {\n \"description\": \"A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\\n\\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipping_rule_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\\n\"\n },\n \"tax_identifiers\": {\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A tax identifier object\",\n \"properties\": {\n \"identifier_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type | Description\\n|---------------|-----------------------------------------\\n|`vat` | The tax identifier is a Value Added Tax.\\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\\n|`ssn` | The tax identifier is a Social Security Number.\\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\\n|`passport` | The tax identifier is a Passport Number.\\n|`abn` | The tax identifier is an Australian Business Number.\\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\\n\",\n \"enum\": [\n \"vat\",\n \"eori\",\n \"ssn\",\n \"ein\",\n \"tin\",\n \"ioss\",\n \"pan\",\n \"voec\",\n \"pccc\",\n \"oss\",\n \"passport\",\n \"abn\",\n \"ukims\"\n ],\n \"title\": \"identifier_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"issuing_authority\": {\n \"description\": \"The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.\",\n \"type\": \"string\"\n },\n \"taxable_entity_type\": {\n \"allOf\": [\n {\n \"description\": \"The taxable entity type for this tax item. Valid values include the following\\n\\n|Value |Description\\n|:--------- |:-----------------------------------------------------\\n|`shipper` | The shipper is responsible for this tax.\\n|`recipient` | The recipient of the shipment is responsible for this tax.\\n|`ior` | The importer of records is responsible for tax.\\n\",\n \"enum\": [\n \"shipper\",\n \"recipient\",\n \"ior\"\n ],\n \"title\": \"taxable_entity_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The value of the identifier\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"taxable_entity_type\",\n \"identifier_type\",\n \"issuing_authority\",\n \"value\"\n ],\n \"title\": \"tax_identifier\",\n \"type\": \"object\"\n }\n ]\n },\n \"nullable\": true,\n \"type\": \"array\"\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\\n\",\n \"nullable\": true\n }\n },\n \"required\": [\n \"carrier_id\",\n \"service_code\",\n \"ship_to\",\n \"packages\"\n ],\n \"title\": \"shipment_request\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment information used to generate the label\"\n },\n \"test_label\": {\n \"default\": false,\n \"deprecated\": true,\n \"description\": \"Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.\",\n \"type\": \"boolean\",\n \"writeOnly\": true\n },\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"no_validation\",\n \"writeOnly\": true\n }\n },\n \"title\": \"label_request\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A purchase label request body\",\n \"properties\": {\n \"ship_from_service_point_id\": {\n \"description\": \"A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address.\",\n \"example\": \"614940\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"ship_to_service_point_id\": {\n \"description\": \"A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address.\",\n \"example\": \"614940\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"shipment\"\n ],\n \"title\": \"create_label_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_label\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Purchase Label\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"create_label_from_rate\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used\\nto generate a label without having to refill in the shipment information repeatedly.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_label_from_rate\",\n \"parameters\": [\n {\n \"description\": \"Rate ID\",\n \"in\": \"path\",\n \"name\": \"rate_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/rates/{rate_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A purchase label without shipment resource\",\n \"properties\": {\n \"display_scheme\": {\n \"allOf\": [\n {\n \"description\": \"The display format that the label should be shown in.\",\n \"enum\": [\n \"label\",\n \"paperless\",\n \"label_and_paperless\"\n ],\n \"title\": \"display_scheme\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"label\",\n \"description\": \"The display format that the label should be shown in.\"\n },\n \"label_download_type\": {\n \"allOf\": [\n {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"url\"\n },\n \"label_format\": {\n \"allOf\": [\n {\n \"description\": \"The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\\n|Label Format | Supported Carriers\\n|--------------|-----------------------------------\\n|`pdf` | All carriers\\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\\n\",\n \"enum\": [\n \"pdf\",\n \"png\",\n \"zpl\"\n ],\n \"title\": \"label_format\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pdf\"\n },\n \"label_layout\": {\n \"allOf\": [\n {\n \"description\": \"The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\",\n \"enum\": [\n \"4x6\",\n \"letter\",\n \"A4\",\n \"A6\"\n ],\n \"title\": \"label_layout\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"4x6\"\n },\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"purchase_label_without_shipment\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A purchase label without shipment request body\",\n \"properties\": {\n \"custom_field1\": {\n \"description\": \"Optional - Value will be saved in the shipment's advanced_options > custom_field1\",\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"description\": \"Optional - Value will be saved in the shipment's advanced_options > custom_field2\",\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"description\": \"Optional - Value will be saved in the shipment's advanced_options > custom_field3\",\n \"type\": \"string\"\n }\n },\n \"title\": \"create_label_from_rate_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_label_from_rate\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Purchase Label with Rate ID\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"create_label_from_rate_shopper\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Purchase and print a shipping label using the Rate Shopper. The Rate Shopper\\nautomatically selects the optimal carrier and service from your wallet carriers\\nbased on your specified rate selection strategy (cheapest, fastest, or best_value).\\nFor more information about this in the [rates documentation](https://www.shipengine.com/docs/rates/#about-the-response).\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_label_from_rate_shopper\",\n \"parameters\": [\n {\n \"description\": \"The rate selection strategy for the Rate Shopper. This determines which carrier\\nand service will be automatically selected from your wallet carriers based on\\nthe rates returned for the shipment.\\n\",\n \"in\": \"path\",\n \"name\": \"rate_shopper_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Optional attributes that indicate the most profitable rates\",\n \"enum\": [\n \"best_value\",\n \"cheapest\",\n \"fastest\"\n ],\n \"title\": \"rate_attributes\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/rate_shopper_id/{rate_shopper_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"Request body for creating a label using the Rate Shopper. The Rate Shopper\\nautomatically selects the carrier and service based on your specified strategy.\\n\\n**Important Constraints:**\\n- You MUST provide shipment details inline in the `shipment` object\\n- You MUST NOT set `shipment_id` (inline shipment only)\\n- You MUST NOT include `carrier_id`, `service_code`, or `shipping_rule_id`\\n in the shipment (Rate Shopper selects these automatically)\\n- Only carriers configured in your wallet will be considered\\n- This endpoint is not available in sandbox mode\\n\",\n \"properties\": {\n \"charge_event\": {\n \"allOf\": [\n {\n \"description\": \"Determines when the user's account will be charged for the label.\",\n \"enum\": [\n \"carrier_default\",\n \"on_creation\",\n \"on_carrier_acceptance\"\n ],\n \"title\": \"label_charge_event\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The label charge event.\\n\"\n },\n \"display_scheme\": {\n \"allOf\": [\n {\n \"description\": \"The display format that the label should be shown in.\",\n \"enum\": [\n \"label\",\n \"paperless\",\n \"label_and_paperless\"\n ],\n \"title\": \"display_scheme\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"label\",\n \"description\": \"The display format that the label should be shown in.\"\n },\n \"is_return_label\": {\n \"description\": \"Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned.\\n\",\n \"type\": \"boolean\"\n },\n \"label_download_type\": {\n \"allOf\": [\n {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"url\",\n \"writeOnly\": true\n },\n \"label_format\": {\n \"allOf\": [\n {\n \"description\": \"The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\\n|Label Format | Supported Carriers\\n|--------------|-----------------------------------\\n|`pdf` | All carriers\\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\\n\",\n \"enum\": [\n \"pdf\",\n \"png\",\n \"zpl\"\n ],\n \"title\": \"label_format\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pdf\",\n \"description\": \"The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\"\n },\n \"label_image_id\": {\n \"allOf\": [\n {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The label image resource that was used to create a custom label image.\",\n \"nullable\": true\n },\n \"label_layout\": {\n \"allOf\": [\n {\n \"description\": \"The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\",\n \"enum\": [\n \"4x6\",\n \"letter\",\n \"A4\",\n \"A6\"\n ],\n \"title\": \"label_layout\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"4x6\",\n \"description\": \"The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\"\n },\n \"outbound_label_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is\\nrequired by some carriers.\\n\",\n \"writeOnly\": true\n },\n \"rma_number\": {\n \"description\": \"An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to ship a package for Rate Shopper, such as the origin, the destination, and the package dimensions and weight.\\n\\n**Note:** This schema excludes carrier_id, service_code, and shipping_rule_id as these are automatically selected by the Rate Shopper based on your chosen strategy.\\n\",\n \"properties\": {\n \"advanced_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": true,\n \"description\": \"Advanced shipment options\",\n \"properties\": {\n \"additional_handling\": {\n \"default\": null,\n \"description\": \"Indicate to the carrier that this shipment requires additional handling.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"bill_to_account\": {\n \"default\": null,\n \"description\": \"This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bill_to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true\n },\n \"bill_to_party\": {\n \"allOf\": [\n {\n \"description\": \"The possible bill to party values\",\n \"enum\": [\n \"recipient\",\n \"third_party\"\n ],\n \"title\": \"bill_to_party\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\\n\",\n \"nullable\": true\n },\n \"bill_to_postal_code\": {\n \"default\": null,\n \"description\": \"The postal code of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"certificate_number\": {\n \"default\": null,\n \"description\": \"certificate_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 784515,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"collect_on_delivery\": {\n \"description\": \"Defer payment until package is delivered, instead of when it is ordered.\",\n \"properties\": {\n \"payment_amount\": {\n \"properties\": {\n \"amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"payment_amount\",\n \"type\": \"object\"\n },\n \"payment_type\": {\n \"allOf\": [\n {\n \"description\": \"Types of payment that are supported\",\n \"enum\": [\n \"any\",\n \"cash\",\n \"cash_equivalent\",\n \"none\"\n ],\n \"title\": \"collect_on_delivery_payment_type\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"collect_on_delivery\",\n \"type\": \"object\"\n },\n \"contains_alcohol\": {\n \"default\": false,\n \"description\": \"Indicates that the shipment contains alcohol.\",\n \"type\": \"boolean\"\n },\n \"custom_field1\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_goods\": {\n \"default\": false,\n \"description\": \"Indicates if the Dangerous goods are present in the shipment\",\n \"type\": \"boolean\"\n },\n \"dangerous_goods_contact\": {\n \"description\": \"Contact information for Dangerous goods\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the contact\",\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number of the contact\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"delivered_duty_paid\": {\n \"default\": false,\n \"description\": \"Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\\n\",\n \"type\": \"boolean\"\n },\n \"delivery-as-addressed\": {\n \"default\": false,\n \"description\": \"Instructs the carrier to deliver the package only to the exact address provided.\",\n \"type\": \"boolean\"\n },\n \"dry_ice\": {\n \"default\": false,\n \"description\": \"Indicates if the shipment contain dry ice\",\n \"type\": \"boolean\"\n },\n \"dry_ice_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the dry ice in the shipment\",\n \"nullable\": true\n },\n \"fedex_freight\": {\n \"description\": \"Provide details for the Fedex freight service\",\n \"properties\": {\n \"booking_confirmation\": {\n \"type\": \"string\"\n },\n \"shipper_load_and_count\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"fragile\": {\n \"default\": false,\n \"description\": \"Indicates that the contents of the package are fragile and should be handled with care.\",\n \"type\": \"boolean\"\n },\n \"freight_class\": {\n \"default\": null,\n \"description\": \"The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \\\"77.5\\\", \\\"110\\\", or \\\"250\\\".\\n\",\n \"example\": 77.5,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"default\": null,\n \"description\": \"invoice_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": \"IOC56888\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"license_number\": {\n \"default\": null,\n \"description\": \"license_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 514785,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"non_machinable\": {\n \"default\": false,\n \"description\": \"Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\\n\",\n \"type\": \"boolean\"\n },\n \"origin_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates if the package will be picked up or dropped off by the carrier\",\n \"enum\": [\n \"pickup\",\n \"drop_off\"\n ],\n \"title\": \"origin_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"nullable\": true\n },\n \"regulated_content_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"enum\": [\n \"day_old_poultry\",\n \"other_live_animal\"\n ],\n \"title\": \"regulated_content_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"nullable\": true\n },\n \"return-after-first-attempt\": {\n \"default\": false,\n \"description\": \"Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.\",\n \"type\": \"boolean\"\n },\n \"saturday_delivery\": {\n \"default\": false,\n \"description\": \"Enables Saturday delivery, if supported by the carrier.\",\n \"type\": \"boolean\"\n },\n \"shipper_release\": {\n \"default\": null,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"third_party_consignee\": {\n \"default\": false,\n \"description\": \"Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached\",\n \"type\": \"boolean\"\n },\n \"use_ups_ground_freight_pricing\": {\n \"default\": null,\n \"description\": \"Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"windsor_framework_details\": {\n \"description\": \"The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.\",\n \"properties\": {\n \"movement_indicator\": {\n \"description\": \"An indicator that will tell the carrier and HMRC the type of movement for the shipment.\",\n \"enum\": [\n \"c2c\",\n \"b2c\",\n \"c2b\",\n \"b2b\"\n ],\n \"type\": \"string\"\n },\n \"not_at_risk\": {\n \"description\": \"An indicator that allows a shipper to declare the shipment as not-at-risk.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"title\": \"advanced_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Advanced shipment options. These are entirely optional.\"\n },\n \"comparison_rate_type\": {\n \"description\": \"Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.\",\n \"example\": \"retail\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The type of delivery confirmation that is required for this shipment.\"\n },\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"customs\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Options for international shipments, such as customs declarations.\",\n \"properties\": {\n \"certificate_number\": {\n \"description\": \"The certificate number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"contents\": {\n \"allOf\": [\n {\n \"description\": \"The possible package contents values\",\n \"enum\": [\n \"merchandise\",\n \"documents\",\n \"gift\",\n \"returned_goods\",\n \"sample\",\n \"other\"\n ],\n \"title\": \"package_contents\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"merchandise\",\n \"description\": \"The type of contents in this shipment. This may impact import duties or customs treatment.\"\n },\n \"contents_explanation\": {\n \"description\": \"Explanation for contents (required if the `contents` is provided as `other`)\",\n \"type\": \"string\"\n },\n \"customs_items\": {\n \"default\": [],\n \"deprecated\": true,\n \"description\": \"Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"customs_item_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the customs item\",\n \"readOnly\": true\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the customs item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"value_currency\": {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"required\": [\n \"customs_item_id\"\n ],\n \"title\": \"customs_item\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"declaration\": {\n \"description\": \"Declaration statement to be placed on the commercial invoice\",\n \"type\": \"string\"\n },\n \"importer_of_record\": {\n \"allOf\": [\n {\n \"description\": \"importer of records address, anywhere in the world.\\n\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"postal_code\",\n \"country_code\"\n ],\n \"title\": \"importer_of_records\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"invoice_additional_details\": {\n \"allOf\": [\n {\n \"description\": \"The additional information to put on commercial invoice \\n\",\n \"properties\": {\n \"discount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Discount for shipment.\"\n },\n \"estimated_import_charges\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\\n\",\n \"properties\": {\n \"duties\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import duties.\"\n },\n \"taxes\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import taxes.\"\n }\n },\n \"title\": \"estimated_import_charges\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\"\n },\n \"freight_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Freight Charge for shipment.\"\n },\n \"insurance_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Insurance Charge for shipment.\"\n },\n \"invoice_number\": {\n \"description\": \"The invoice number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"other_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Other charge for shipment.\"\n },\n \"other_charge_description\": {\n \"description\": \"Description for the other charge (if provided).\",\n \"type\": \"string\"\n }\n },\n \"title\": \"invoice_additional_details\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"license_number\": {\n \"description\": \"The license number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"non_delivery\": {\n \"allOf\": [\n {\n \"description\": \"The possible non delivery values\",\n \"enum\": [\n \"return_to_sender\",\n \"treat_as_abandoned\"\n ],\n \"title\": \"non_delivery\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"return_to_sender\",\n \"description\": \"Indicates what to do if a package is unable to be delivered.\"\n },\n \"terms_of_trade_code\": {\n \"allOf\": [\n {\n \"enum\": [\n \"exw\",\n \"fca\",\n \"cpt\",\n \"cip\",\n \"dpu\",\n \"dap\",\n \"ddp\",\n \"fas\",\n \"fob\",\n \"cfr\",\n \"cif\",\n \"ddu\",\n \"daf\",\n \"deq\",\n \"des\"\n ],\n \"title\": \"Allowed incoterms\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Specifies the supported terms of trade code (incoterms)\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"contents\",\n \"non_delivery\"\n ],\n \"title\": \"international_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"default\": null,\n \"description\": \"Customs information. This is usually only needed for international shipments.\\n\",\n \"nullable\": true\n },\n \"external_order_id\": {\n \"description\": \"ID that the Order Source assigned\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_shipment_id\": {\n \"description\": \"A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\\n\\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"insurance_provider\": {\n \"allOf\": [\n {\n \"description\": \"The possible insurance provider values\",\n \"enum\": [\n \"none\",\n \"shipsurance\",\n \"carrier\",\n \"third_party\"\n ],\n \"title\": \"insurance_provider\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The insurance provider to use for any insured packages in the shipment.\\n\"\n },\n \"is_return\": {\n \"default\": false,\n \"description\": \"An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"items\": {\n \"default\": [],\n \"description\": \"Describe the packages included in this shipment as related to potential metadata that was imported from\\nexternal order sources\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A shipment item\",\n \"properties\": {\n \"asin\": {\n \"description\": \"Amazon Standard Identification Number\",\n \"example\": \"B00005N5PF\",\n \"maxLength\": 10,\n \"minLength\": 10,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bundle_sku\": {\n \"description\": \"Item Stock Keeping Unit of the product bundle\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"external_order_id\": {\n \"description\": \"external order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_order_item_id\": {\n \"description\": \"external order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"item name\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"quantity\": {\n \"description\": \"The quantity of this item included in the shipment\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sales_order_id\": {\n \"description\": \"sales order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sales_order_item_id\": {\n \"description\": \"sales order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku\": {\n \"description\": \"Item Stock Keeping Unit\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"shipment_item\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created or last modified.\",\n \"readOnly\": true\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"packages\": {\n \"description\": \"The packages in the shipment.\\n\\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package associated with a shipment\\n\",\n \"properties\": {\n \"content_description\": {\n \"description\": \"A short description of the package content. Required for shipments moving to, from, and through Mexico.\\n\",\n \"example\": \"Hand knitted wool socks\",\n \"maxLength\": 35,\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n },\n \"external_package_id\": {\n \"description\": \"An external package id.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"insured_value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"default\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"description\": \"The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\\n\"\n },\n \"label_messages\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\\n\\n|Carrier |Max lines |Max line length\\n|-------------------|----------|--------------------\\n|USPS (Stamps.com) |3 |60\\n|FedEx |3 |35 for the first line. 30 for additional lines.\\n|UPS |2 |35\\n|OnTrac |2 |25\\n\",\n \"properties\": {\n \"reference1\": {\n \"default\": null,\n \"description\": \"The first line of the custom label message. Some carriers may prefix this line with something like \\\"REF\\\", \\\"Reference\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference2\": {\n \"default\": null,\n \"description\": \"The second line of the custom label message. Some carriers may prefix this line with something like \\\"INV\\\", \\\"Reference 2\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference3\": {\n \"default\": null,\n \"description\": \"The third line of the custom label message. Some carriers may prefix this line with something like \\\"PO\\\", \\\"Reference 3\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"reference1\",\n \"reference2\",\n \"reference3\"\n ],\n \"title\": \"label_messages\",\n \"type\": \"object\"\n }\n ]\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\\n\"\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\"\n },\n \"package_name\": {\n \"description\": \"The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\",\n \"type\": \"string\"\n },\n \"products\": {\n \"default\": [],\n \"description\": \"Details about products inside packages (Information provided would be used on custom documentation)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"dangerous_goods\": {\n \"default\": [],\n \"description\": \"Details about dangerous goods inside products\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"Dangerous goods attribute associated with the product\\n\",\n \"properties\": {\n \"additional_description\": {\n \"default\": null,\n \"description\": \"Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_amount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"This model represents the amount of the dangerous goods..\",\n \"properties\": {\n \"amount\": {\n \"default\": 0,\n \"description\": \"The amount of dangerous goods.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"default\": null,\n \"description\": \"The unit of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_amount\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"This model represents the amount of the dangerous goods.\"\n },\n \"id_number\": {\n \"default\": null,\n \"description\": \"UN number to identify the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_group\": {\n \"enum\": [\n \"i\",\n \"ii\",\n \"iii\"\n ],\n \"title\": \"packaging_group\",\n \"type\": \"string\"\n },\n \"packaging_instruction\": {\n \"default\": null,\n \"description\": \"The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_instruction_section\": {\n \"enum\": [\n \"section_1\",\n \"section_2\",\n \"section_1a\",\n \"section_1b\"\n ],\n \"title\": \"packaging_instruction_section\",\n \"type\": \"string\"\n },\n \"packaging_type\": {\n \"default\": null,\n \"description\": \"The type of exterior packaging used to contain the dangerous good.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class\": {\n \"default\": null,\n \"description\": \"Dangerous goods product class based on regulation.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class_subsidiary\": {\n \"default\": null,\n \"description\": \"A secondary of product class for substances presenting more than one particular hazard\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"Quantity of dangerous goods.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"radioactive\": {\n \"description\": \"Indication if the substance is radioactive.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"regulation_authority\": {\n \"default\": null,\n \"description\": \"Name of the regulatory authority.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"regulation_level\": {\n \"enum\": [\n \"lightly_regulated\",\n \"fully_regulated\",\n \"limited_quantities\",\n \"excepted_quantity\"\n ],\n \"title\": \"regulation_level\",\n \"type\": \"string\"\n },\n \"reportable_quantity\": {\n \"description\": \"Indication if the substance needs to be reported to regulatory authority based on the quantity.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"shipping_name\": {\n \"default\": null,\n \"description\": \"Trade description of the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"technical_name\": {\n \"default\": null,\n \"description\": \"Recognized Technical or chemical name of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_category\": {\n \"default\": null,\n \"description\": \"Transport category assign to dangerous goods for the transport purpose.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_mean\": {\n \"enum\": [\n \"ground\",\n \"water\",\n \"cargo_aircraft_only\",\n \"passenger_aircraft\"\n ],\n \"title\": \"transport_mean\",\n \"type\": \"string\"\n },\n \"tunnel_code\": {\n \"default\": null,\n \"description\": \"Defines which types of tunnels the shipment is allowed to go through\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_goods\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"extended_details\": {\n \"additionalProperties\": true,\n \"description\": \"Additional details about products\",\n \"type\": \"object\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"mid_code\": {\n \"description\": \"Manufacturers Identification code\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_url\": {\n \"description\": \"link to the item on the seller website\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The declared value of each item\"\n },\n \"vat_rate\": {\n \"description\": \"VAT rate applicable to the item\",\n \"example\": 0.2,\n \"nullable\": true,\n \"type\": \"number\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"title\": \"products\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"shipment_package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this shipment package\",\n \"readOnly\": true\n },\n \"tracking_number\": {\n \"allOf\": [\n {\n \"description\": \"A tracking number for a package. The format depends on the carrier.\",\n \"example\": \"1Z932R800392060079\",\n \"minLength\": 1,\n \"title\": \"tracking_number\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The tracking number for the package. The format depends on the carrier.\\n\",\n \"readOnly\": true\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package weight\"\n }\n },\n \"required\": [\n \"weight\"\n ],\n \"title\": \"package\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"return_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address for this shipment. Defaults to the `ship_from` address.\\n\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\\n\",\n \"example\": \"2018-09-23T00:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}(T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2}))?$\",\n \"title\": \"date\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\\n\"\n },\n \"ship_from\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\\n\"\n },\n \"ship_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"geolocation\": {\n \"items\": {\n \"properties\": {\n \"type\": {\n \"description\": \"Enum of available type of geolocation items:\\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\\n\",\n \"enum\": [\n \"what3words\"\n ],\n \"example\": \"what3words\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"value of the geolocation item\",\n \"example\": \"cats.with.thumbs\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The recipient's mailing address\"\n },\n \"shipment_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the shipment\",\n \"readOnly\": true\n },\n \"shipment_number\": {\n \"description\": \"A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\\n\\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment_status\": {\n \"allOf\": [\n {\n \"description\": \"The possible shipment status values\",\n \"enum\": [\n \"pending\",\n \"processing\",\n \"label_purchased\",\n \"cancelled\"\n ],\n \"title\": \"shipment_status\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pending\",\n \"description\": \"The current status of the shipment\",\n \"readOnly\": true\n },\n \"tags\": {\n \"default\": [],\n \"description\": \"Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"properties\": {\n \"color\": {\n \"description\": \"A hex-coded string identifying the color of the tag.\",\n \"example\": \"#FF0000\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The tag name.\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"tag_id\": {\n \"description\": \"An integer uniquely identifying a tag.\",\n \"example\": 8712,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"title\": \"tag\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 0,\n \"readOnly\": true,\n \"type\": \"array\"\n },\n \"tax_identifiers\": {\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A tax identifier object\",\n \"properties\": {\n \"identifier_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type | Description\\n|---------------|-----------------------------------------\\n|`vat` | The tax identifier is a Value Added Tax.\\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\\n|`ssn` | The tax identifier is a Social Security Number.\\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\\n|`passport` | The tax identifier is a Passport Number.\\n|`abn` | The tax identifier is an Australian Business Number.\\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\\n\",\n \"enum\": [\n \"vat\",\n \"eori\",\n \"ssn\",\n \"ein\",\n \"tin\",\n \"ioss\",\n \"pan\",\n \"voec\",\n \"pccc\",\n \"oss\",\n \"passport\",\n \"abn\",\n \"ukims\"\n ],\n \"title\": \"identifier_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"issuing_authority\": {\n \"description\": \"The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.\",\n \"type\": \"string\"\n },\n \"taxable_entity_type\": {\n \"allOf\": [\n {\n \"description\": \"The taxable entity type for this tax item. Valid values include the following\\n\\n|Value |Description\\n|:--------- |:-----------------------------------------------------\\n|`shipper` | The shipper is responsible for this tax.\\n|`recipient` | The recipient of the shipment is responsible for this tax.\\n|`ior` | The importer of records is responsible for tax.\\n\",\n \"enum\": [\n \"shipper\",\n \"recipient\",\n \"ior\"\n ],\n \"title\": \"taxable_entity_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The value of the identifier\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"taxable_entity_type\",\n \"identifier_type\",\n \"issuing_authority\",\n \"value\"\n ],\n \"title\": \"tax_identifier\",\n \"type\": \"object\"\n }\n ]\n },\n \"nullable\": true,\n \"type\": \"array\"\n },\n \"total_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The combined weight of all packages in the shipment\",\n \"readOnly\": true\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\\n\",\n \"nullable\": true\n },\n \"zone\": {\n \"description\": \"Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\\ncustom zones that vary depending upon the ship_to and ship_from location\\n\",\n \"example\": 6,\n \"format\": \"int32\",\n \"minimum\": 0,\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"title\": \"partial_shipment_for_rate_shopper\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment details for which to create a label. Must be provided inline.\\nThe carrier_id, service_code, and shipping_rule_id are not included as these\\nwill be automatically determined by the Rate Shopper based on your strategy.\\n\"\n },\n \"test_label\": {\n \"default\": false,\n \"deprecated\": true,\n \"description\": \"Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.\",\n \"type\": \"boolean\",\n \"writeOnly\": true\n },\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"no_validation\",\n \"writeOnly\": true\n }\n },\n \"required\": [\n \"shipment\"\n ],\n \"title\": \"create_label_rate_shopper_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_label_from_rate_shopper\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Purchase Label from Rate Shopper\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"create_label_from_shipment\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Purchase a label using a shipment ID that has already been created with the desired address and\\npackage info.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_label_from_shipment\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/shipment/{shipment_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A purchase label without shipment request body\",\n \"properties\": {\n \"display_scheme\": {\n \"allOf\": [\n {\n \"description\": \"The display format that the label should be shown in.\",\n \"enum\": [\n \"label\",\n \"paperless\",\n \"label_and_paperless\"\n ],\n \"title\": \"display_scheme\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"label\",\n \"description\": \"The display format that the label should be shown in.\"\n },\n \"label_download_type\": {\n \"allOf\": [\n {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"url\"\n },\n \"label_format\": {\n \"allOf\": [\n {\n \"description\": \"The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\\n|Label Format | Supported Carriers\\n|--------------|-----------------------------------\\n|`pdf` | All carriers\\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\\n\",\n \"enum\": [\n \"pdf\",\n \"png\",\n \"zpl\"\n ],\n \"title\": \"label_format\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pdf\"\n },\n \"label_layout\": {\n \"allOf\": [\n {\n \"description\": \"The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\",\n \"enum\": [\n \"4x6\",\n \"letter\",\n \"A4\",\n \"A6\"\n ],\n \"title\": \"label_layout\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"4x6\"\n },\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"create_label_from_shipment_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_label_from_shipment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Purchase Label with Shipment ID\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"create_manifest\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id\\nrather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_manifest\",\n \"parameters\": [],\n \"path\": \"/v1/manifests\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A create manifest request body\",\n \"properties\": {\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the carrier\"\n },\n \"excluded_label_ids\": {\n \"description\": \"The list of label ids to exclude from the manifest\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Label Id that will be excluded from the manifest\"\n },\n \"type\": \"array\"\n },\n \"label_ids\": {\n \"description\": \"The list of label ids to include for the manifest\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Label Id that will be included for the manifest\"\n },\n \"type\": \"array\"\n },\n \"ship_date\": {\n \"description\": \"The ship date that the shipment will be sent out on\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the warehouse\"\n }\n },\n \"required\": [\n \"carrier_id\",\n \"warehouse_id\",\n \"ship_date\"\n ],\n \"title\": \"create_manifest_by_object_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A create manifest request body\",\n \"properties\": {\n \"label_ids\": {\n \"description\": \"The list of label ids to include in the manifest\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Label Id that will be included in the manifest\"\n },\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"label_ids\"\n ],\n \"title\": \"create_manifest_label_ids_request_body\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"create_manifest_request_body\"\n },\n \"security\": null,\n \"skill_name\": \"create_manifest\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create Manifest\",\n \"tags\": [\n \"manifests\"\n ]\n },\n \"create_package_type\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create a custom package type to better assist in getting accurate rate estimates\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_package_type\",\n \"parameters\": [],\n \"path\": \"/v1/packages\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package type that a carrier supports for shipment.\",\n \"properties\": {\n \"description\": {\n \"description\": \"Provides a helpful description for the custom package.\",\n \"example\": \"Packaging for laptops\",\n \"maxLength\": 500,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The custom dimensions for the package.\"\n },\n \"name\": {\n \"example\": \"laptop_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the package.\"\n }\n },\n \"required\": [\n \"name\",\n \"package_code\"\n ],\n \"title\": \"package_type\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A create package type request body\",\n \"title\": \"create_package_type_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_package_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create Custom Package Type\",\n \"tags\": [\n \"package_types\"\n ]\n },\n \"create_return_label\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create a return label for an existing outbound label. You can optionally specify a custom RMA (Return Merchandise Authorization) number. If no RMA number is provided, the system will auto-generate one.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_return_label\",\n \"parameters\": [\n {\n \"description\": \"Label ID\",\n \"in\": \"path\",\n \"name\": \"label_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/{label_id}/return\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A create return label request body\",\n \"properties\": {\n \"charge_event\": {\n \"allOf\": [\n {\n \"description\": \"Determines when the user's account will be charged for the label.\",\n \"enum\": [\n \"carrier_default\",\n \"on_creation\",\n \"on_carrier_acceptance\"\n ],\n \"title\": \"label_charge_event\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The label charge event.\\n\"\n },\n \"display_scheme\": {\n \"allOf\": [\n {\n \"description\": \"The display format that the label should be shown in.\",\n \"enum\": [\n \"label\",\n \"paperless\",\n \"label_and_paperless\"\n ],\n \"title\": \"display_scheme\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"label\",\n \"description\": \"The display format that the label should be shown in.\"\n },\n \"label_download_type\": {\n \"allOf\": [\n {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"url\",\n \"writeOnly\": true\n },\n \"label_format\": {\n \"allOf\": [\n {\n \"description\": \"The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\\n|Label Format | Supported Carriers\\n|--------------|-----------------------------------\\n|`pdf` | All carriers\\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\\n\",\n \"enum\": [\n \"pdf\",\n \"png\",\n \"zpl\"\n ],\n \"title\": \"label_format\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pdf\",\n \"description\": \"The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\"\n },\n \"label_image_id\": {\n \"allOf\": [\n {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The label image resource that was used to create a custom label image.\",\n \"nullable\": true\n },\n \"label_layout\": {\n \"allOf\": [\n {\n \"description\": \"The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\",\n \"enum\": [\n \"4x6\",\n \"letter\",\n \"A4\",\n \"A6\"\n ],\n \"title\": \"label_layout\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"4x6\",\n \"description\": \"The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\"\n },\n \"rma_number\": {\n \"description\": \"An optional Return Merchandise Authorization number. If provided, this value will be used as the return label's RMA number. If omitted, the system will auto-generate an RMA number (current default behavior). You can set it to any string value.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"create_return_label_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_return_label\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create a return label\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"create_shipments\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create one or multiple shipments.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_shipments\",\n \"parameters\": [],\n \"path\": \"/v1/shipments\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A create shipments request body\",\n \"properties\": {\n \"shipments\": {\n \"description\": \"An array of shipments to be created.\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"properties\": {\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"no_validation\"\n }\n },\n \"title\": \"validate_shipment_fields\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\\n\",\n \"properties\": {\n \"advanced_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": true,\n \"description\": \"Advanced shipment options\",\n \"properties\": {\n \"additional_handling\": {\n \"default\": null,\n \"description\": \"Indicate to the carrier that this shipment requires additional handling.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"bill_to_account\": {\n \"default\": null,\n \"description\": \"This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bill_to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true\n },\n \"bill_to_party\": {\n \"allOf\": [\n {\n \"description\": \"The possible bill to party values\",\n \"enum\": [\n \"recipient\",\n \"third_party\"\n ],\n \"title\": \"bill_to_party\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\\n\",\n \"nullable\": true\n },\n \"bill_to_postal_code\": {\n \"default\": null,\n \"description\": \"The postal code of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"certificate_number\": {\n \"default\": null,\n \"description\": \"certificate_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 784515,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"collect_on_delivery\": {\n \"description\": \"Defer payment until package is delivered, instead of when it is ordered.\",\n \"properties\": {\n \"payment_amount\": {\n \"properties\": {\n \"amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"payment_amount\",\n \"type\": \"object\"\n },\n \"payment_type\": {\n \"allOf\": [\n {\n \"description\": \"Types of payment that are supported\",\n \"enum\": [\n \"any\",\n \"cash\",\n \"cash_equivalent\",\n \"none\"\n ],\n \"title\": \"collect_on_delivery_payment_type\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"collect_on_delivery\",\n \"type\": \"object\"\n },\n \"contains_alcohol\": {\n \"default\": false,\n \"description\": \"Indicates that the shipment contains alcohol.\",\n \"type\": \"boolean\"\n },\n \"custom_field1\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_goods\": {\n \"default\": false,\n \"description\": \"Indicates if the Dangerous goods are present in the shipment\",\n \"type\": \"boolean\"\n },\n \"dangerous_goods_contact\": {\n \"description\": \"Contact information for Dangerous goods\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the contact\",\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number of the contact\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"delivered_duty_paid\": {\n \"default\": false,\n \"description\": \"Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\\n\",\n \"type\": \"boolean\"\n },\n \"delivery-as-addressed\": {\n \"default\": false,\n \"description\": \"Instructs the carrier to deliver the package only to the exact address provided.\",\n \"type\": \"boolean\"\n },\n \"dry_ice\": {\n \"default\": false,\n \"description\": \"Indicates if the shipment contain dry ice\",\n \"type\": \"boolean\"\n },\n \"dry_ice_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the dry ice in the shipment\",\n \"nullable\": true\n },\n \"fedex_freight\": {\n \"description\": \"Provide details for the Fedex freight service\",\n \"properties\": {\n \"booking_confirmation\": {\n \"type\": \"string\"\n },\n \"shipper_load_and_count\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"fragile\": {\n \"default\": false,\n \"description\": \"Indicates that the contents of the package are fragile and should be handled with care.\",\n \"type\": \"boolean\"\n },\n \"freight_class\": {\n \"default\": null,\n \"description\": \"The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \\\"77.5\\\", \\\"110\\\", or \\\"250\\\".\\n\",\n \"example\": 77.5,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"default\": null,\n \"description\": \"invoice_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": \"IOC56888\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"license_number\": {\n \"default\": null,\n \"description\": \"license_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 514785,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"non_machinable\": {\n \"default\": false,\n \"description\": \"Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\\n\",\n \"type\": \"boolean\"\n },\n \"origin_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates if the package will be picked up or dropped off by the carrier\",\n \"enum\": [\n \"pickup\",\n \"drop_off\"\n ],\n \"title\": \"origin_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"nullable\": true\n },\n \"regulated_content_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"enum\": [\n \"day_old_poultry\",\n \"other_live_animal\"\n ],\n \"title\": \"regulated_content_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"nullable\": true\n },\n \"return-after-first-attempt\": {\n \"default\": false,\n \"description\": \"Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.\",\n \"type\": \"boolean\"\n },\n \"saturday_delivery\": {\n \"default\": false,\n \"description\": \"Enables Saturday delivery, if supported by the carrier.\",\n \"type\": \"boolean\"\n },\n \"shipper_release\": {\n \"default\": null,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"third_party_consignee\": {\n \"default\": false,\n \"description\": \"Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached\",\n \"type\": \"boolean\"\n },\n \"use_ups_ground_freight_pricing\": {\n \"default\": null,\n \"description\": \"Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"windsor_framework_details\": {\n \"description\": \"The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.\",\n \"properties\": {\n \"movement_indicator\": {\n \"description\": \"An indicator that will tell the carrier and HMRC the type of movement for the shipment.\",\n \"enum\": [\n \"c2c\",\n \"b2c\",\n \"c2b\",\n \"b2b\"\n ],\n \"type\": \"string\"\n },\n \"not_at_risk\": {\n \"description\": \"An indicator that allows a shipper to declare the shipment as not-at-risk.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"title\": \"advanced_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Advanced shipment options. These are entirely optional.\"\n },\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The carrier account that is billed for the shipping charges\"\n },\n \"comparison_rate_type\": {\n \"description\": \"Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.\",\n \"example\": \"retail\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The type of delivery confirmation that is required for this shipment.\"\n },\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"customs\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Options for international shipments, such as customs declarations.\",\n \"properties\": {\n \"certificate_number\": {\n \"description\": \"The certificate number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"contents\": {\n \"allOf\": [\n {\n \"description\": \"The possible package contents values\",\n \"enum\": [\n \"merchandise\",\n \"documents\",\n \"gift\",\n \"returned_goods\",\n \"sample\",\n \"other\"\n ],\n \"title\": \"package_contents\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"merchandise\",\n \"description\": \"The type of contents in this shipment. This may impact import duties or customs treatment.\"\n },\n \"contents_explanation\": {\n \"description\": \"Explanation for contents (required if the `contents` is provided as `other`)\",\n \"type\": \"string\"\n },\n \"customs_items\": {\n \"default\": [],\n \"deprecated\": true,\n \"description\": \"Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"customs_item_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the customs item\",\n \"readOnly\": true\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the customs item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"value_currency\": {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"required\": [\n \"customs_item_id\"\n ],\n \"title\": \"customs_item\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"declaration\": {\n \"description\": \"Declaration statement to be placed on the commercial invoice\",\n \"type\": \"string\"\n },\n \"importer_of_record\": {\n \"allOf\": [\n {\n \"description\": \"importer of records address, anywhere in the world.\\n\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"postal_code\",\n \"country_code\"\n ],\n \"title\": \"importer_of_records\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"invoice_additional_details\": {\n \"allOf\": [\n {\n \"description\": \"The additional information to put on commercial invoice \\n\",\n \"properties\": {\n \"discount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Discount for shipment.\"\n },\n \"estimated_import_charges\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\\n\",\n \"properties\": {\n \"duties\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import duties.\"\n },\n \"taxes\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import taxes.\"\n }\n },\n \"title\": \"estimated_import_charges\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\"\n },\n \"freight_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Freight Charge for shipment.\"\n },\n \"insurance_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Insurance Charge for shipment.\"\n },\n \"invoice_number\": {\n \"description\": \"The invoice number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"other_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Other charge for shipment.\"\n },\n \"other_charge_description\": {\n \"description\": \"Description for the other charge (if provided).\",\n \"type\": \"string\"\n }\n },\n \"title\": \"invoice_additional_details\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"license_number\": {\n \"description\": \"The license number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"non_delivery\": {\n \"allOf\": [\n {\n \"description\": \"The possible non delivery values\",\n \"enum\": [\n \"return_to_sender\",\n \"treat_as_abandoned\"\n ],\n \"title\": \"non_delivery\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"return_to_sender\",\n \"description\": \"Indicates what to do if a package is unable to be delivered.\"\n },\n \"terms_of_trade_code\": {\n \"allOf\": [\n {\n \"enum\": [\n \"exw\",\n \"fca\",\n \"cpt\",\n \"cip\",\n \"dpu\",\n \"dap\",\n \"ddp\",\n \"fas\",\n \"fob\",\n \"cfr\",\n \"cif\",\n \"ddu\",\n \"daf\",\n \"deq\",\n \"des\"\n ],\n \"title\": \"Allowed incoterms\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Specifies the supported terms of trade code (incoterms)\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"contents\",\n \"non_delivery\"\n ],\n \"title\": \"international_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"default\": null,\n \"description\": \"Customs information. This is usually only needed for international shipments.\\n\",\n \"nullable\": true\n },\n \"external_order_id\": {\n \"description\": \"ID that the Order Source assigned\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_shipment_id\": {\n \"description\": \"A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\\n\\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"insurance_provider\": {\n \"allOf\": [\n {\n \"description\": \"The possible insurance provider values\",\n \"enum\": [\n \"none\",\n \"shipsurance\",\n \"carrier\",\n \"third_party\"\n ],\n \"title\": \"insurance_provider\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The insurance provider to use for any insured packages in the shipment.\\n\"\n },\n \"is_return\": {\n \"default\": false,\n \"description\": \"An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"items\": {\n \"default\": [],\n \"description\": \"Describe the packages included in this shipment as related to potential metadata that was imported from\\nexternal order sources\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A shipment item\",\n \"properties\": {\n \"asin\": {\n \"description\": \"Amazon Standard Identification Number\",\n \"example\": \"B00005N5PF\",\n \"maxLength\": 10,\n \"minLength\": 10,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bundle_sku\": {\n \"description\": \"Item Stock Keeping Unit of the product bundle\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"external_order_id\": {\n \"description\": \"external order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_order_item_id\": {\n \"description\": \"external order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"item name\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"quantity\": {\n \"description\": \"The quantity of this item included in the shipment\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sales_order_id\": {\n \"description\": \"sales order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sales_order_item_id\": {\n \"description\": \"sales order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku\": {\n \"description\": \"Item Stock Keeping Unit\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"shipment_item\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created or last modified.\",\n \"readOnly\": true\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"packages\": {\n \"description\": \"The packages in the shipment.\\n\\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package associated with a shipment\\n\",\n \"properties\": {\n \"content_description\": {\n \"description\": \"A short description of the package content. Required for shipments moving to, from, and through Mexico.\\n\",\n \"example\": \"Hand knitted wool socks\",\n \"maxLength\": 35,\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n },\n \"external_package_id\": {\n \"description\": \"An external package id.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"insured_value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"default\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"description\": \"The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\\n\"\n },\n \"label_messages\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\\n\\n|Carrier |Max lines |Max line length\\n|-------------------|----------|--------------------\\n|USPS (Stamps.com) |3 |60\\n|FedEx |3 |35 for the first line. 30 for additional lines.\\n|UPS |2 |35\\n|OnTrac |2 |25\\n\",\n \"properties\": {\n \"reference1\": {\n \"default\": null,\n \"description\": \"The first line of the custom label message. Some carriers may prefix this line with something like \\\"REF\\\", \\\"Reference\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference2\": {\n \"default\": null,\n \"description\": \"The second line of the custom label message. Some carriers may prefix this line with something like \\\"INV\\\", \\\"Reference 2\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference3\": {\n \"default\": null,\n \"description\": \"The third line of the custom label message. Some carriers may prefix this line with something like \\\"PO\\\", \\\"Reference 3\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"reference1\",\n \"reference2\",\n \"reference3\"\n ],\n \"title\": \"label_messages\",\n \"type\": \"object\"\n }\n ]\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\\n\"\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\"\n },\n \"package_name\": {\n \"description\": \"The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\",\n \"type\": \"string\"\n },\n \"products\": {\n \"default\": [],\n \"description\": \"Details about products inside packages (Information provided would be used on custom documentation)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"dangerous_goods\": {\n \"default\": [],\n \"description\": \"Details about dangerous goods inside products\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"Dangerous goods attribute associated with the product\\n\",\n \"properties\": {\n \"additional_description\": {\n \"default\": null,\n \"description\": \"Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_amount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"This model represents the amount of the dangerous goods..\",\n \"properties\": {\n \"amount\": {\n \"default\": 0,\n \"description\": \"The amount of dangerous goods.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"default\": null,\n \"description\": \"The unit of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_amount\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"This model represents the amount of the dangerous goods.\"\n },\n \"id_number\": {\n \"default\": null,\n \"description\": \"UN number to identify the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_group\": {\n \"enum\": [\n \"i\",\n \"ii\",\n \"iii\"\n ],\n \"title\": \"packaging_group\",\n \"type\": \"string\"\n },\n \"packaging_instruction\": {\n \"default\": null,\n \"description\": \"The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_instruction_section\": {\n \"enum\": [\n \"section_1\",\n \"section_2\",\n \"section_1a\",\n \"section_1b\"\n ],\n \"title\": \"packaging_instruction_section\",\n \"type\": \"string\"\n },\n \"packaging_type\": {\n \"default\": null,\n \"description\": \"The type of exterior packaging used to contain the dangerous good.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class\": {\n \"default\": null,\n \"description\": \"Dangerous goods product class based on regulation.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class_subsidiary\": {\n \"default\": null,\n \"description\": \"A secondary of product class for substances presenting more than one particular hazard\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"Quantity of dangerous goods.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"radioactive\": {\n \"description\": \"Indication if the substance is radioactive.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"regulation_authority\": {\n \"default\": null,\n \"description\": \"Name of the regulatory authority.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"regulation_level\": {\n \"enum\": [\n \"lightly_regulated\",\n \"fully_regulated\",\n \"limited_quantities\",\n \"excepted_quantity\"\n ],\n \"title\": \"regulation_level\",\n \"type\": \"string\"\n },\n \"reportable_quantity\": {\n \"description\": \"Indication if the substance needs to be reported to regulatory authority based on the quantity.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"shipping_name\": {\n \"default\": null,\n \"description\": \"Trade description of the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"technical_name\": {\n \"default\": null,\n \"description\": \"Recognized Technical or chemical name of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_category\": {\n \"default\": null,\n \"description\": \"Transport category assign to dangerous goods for the transport purpose.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_mean\": {\n \"enum\": [\n \"ground\",\n \"water\",\n \"cargo_aircraft_only\",\n \"passenger_aircraft\"\n ],\n \"title\": \"transport_mean\",\n \"type\": \"string\"\n },\n \"tunnel_code\": {\n \"default\": null,\n \"description\": \"Defines which types of tunnels the shipment is allowed to go through\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_goods\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"extended_details\": {\n \"additionalProperties\": true,\n \"description\": \"Additional details about products\",\n \"type\": \"object\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"mid_code\": {\n \"description\": \"Manufacturers Identification code\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_url\": {\n \"description\": \"link to the item on the seller website\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The declared value of each item\"\n },\n \"vat_rate\": {\n \"description\": \"VAT rate applicable to the item\",\n \"example\": 0.2,\n \"nullable\": true,\n \"type\": \"number\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"title\": \"products\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"shipment_package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this shipment package\",\n \"readOnly\": true\n },\n \"tracking_number\": {\n \"allOf\": [\n {\n \"description\": \"A tracking number for a package. The format depends on the carrier.\",\n \"example\": \"1Z932R800392060079\",\n \"minLength\": 1,\n \"title\": \"tracking_number\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The tracking number for the package. The format depends on the carrier.\\n\",\n \"readOnly\": true\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package weight\"\n }\n },\n \"required\": [\n \"weight\"\n ],\n \"title\": \"package\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"return_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address for this shipment. Defaults to the `ship_from` address.\\n\"\n },\n \"service_code\": {\n \"allOf\": [\n {\n \"description\": \"A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\",\n \"example\": \"usps_first_class_mail\",\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9-]+)* ?$\",\n \"title\": \"service_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\\n\",\n \"example\": \"2018-09-23T00:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}(T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2}))?$\",\n \"title\": \"date\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\\n\"\n },\n \"ship_from\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\\n\"\n },\n \"ship_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"geolocation\": {\n \"items\": {\n \"properties\": {\n \"type\": {\n \"description\": \"Enum of available type of geolocation items:\\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\\n\",\n \"enum\": [\n \"what3words\"\n ],\n \"example\": \"what3words\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"value of the geolocation item\",\n \"example\": \"cats.with.thumbs\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The recipient's mailing address\"\n },\n \"shipment_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the shipment\",\n \"readOnly\": true\n },\n \"shipment_number\": {\n \"description\": \"A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\\n\\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment_status\": {\n \"allOf\": [\n {\n \"description\": \"The possible shipment status values\",\n \"enum\": [\n \"pending\",\n \"processing\",\n \"label_purchased\",\n \"cancelled\"\n ],\n \"title\": \"shipment_status\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pending\",\n \"description\": \"The current status of the shipment\",\n \"readOnly\": true\n },\n \"shipping_rule_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\\n\"\n },\n \"tags\": {\n \"default\": [],\n \"description\": \"Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"properties\": {\n \"color\": {\n \"description\": \"A hex-coded string identifying the color of the tag.\",\n \"example\": \"#FF0000\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The tag name.\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"tag_id\": {\n \"description\": \"An integer uniquely identifying a tag.\",\n \"example\": 8712,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"title\": \"tag\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 0,\n \"readOnly\": true,\n \"type\": \"array\"\n },\n \"tax_identifiers\": {\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A tax identifier object\",\n \"properties\": {\n \"identifier_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type | Description\\n|---------------|-----------------------------------------\\n|`vat` | The tax identifier is a Value Added Tax.\\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\\n|`ssn` | The tax identifier is a Social Security Number.\\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\\n|`passport` | The tax identifier is a Passport Number.\\n|`abn` | The tax identifier is an Australian Business Number.\\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\\n\",\n \"enum\": [\n \"vat\",\n \"eori\",\n \"ssn\",\n \"ein\",\n \"tin\",\n \"ioss\",\n \"pan\",\n \"voec\",\n \"pccc\",\n \"oss\",\n \"passport\",\n \"abn\",\n \"ukims\"\n ],\n \"title\": \"identifier_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"issuing_authority\": {\n \"description\": \"The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.\",\n \"type\": \"string\"\n },\n \"taxable_entity_type\": {\n \"allOf\": [\n {\n \"description\": \"The taxable entity type for this tax item. Valid values include the following\\n\\n|Value |Description\\n|:--------- |:-----------------------------------------------------\\n|`shipper` | The shipper is responsible for this tax.\\n|`recipient` | The recipient of the shipment is responsible for this tax.\\n|`ior` | The importer of records is responsible for tax.\\n\",\n \"enum\": [\n \"shipper\",\n \"recipient\",\n \"ior\"\n ],\n \"title\": \"taxable_entity_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The value of the identifier\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"taxable_entity_type\",\n \"identifier_type\",\n \"issuing_authority\",\n \"value\"\n ],\n \"title\": \"tax_identifier\",\n \"type\": \"object\"\n }\n ]\n },\n \"nullable\": true,\n \"type\": \"array\"\n },\n \"total_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The combined weight of all packages in the shipment\",\n \"readOnly\": true\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\\n\",\n \"nullable\": true\n },\n \"zone\": {\n \"description\": \"Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\\ncustom zones that vary depending upon the ship_to and ship_from location\\n\",\n \"example\": 6,\n \"format\": \"int32\",\n \"minimum\": 0,\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"title\": \"partial_shipment\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An address validating shipment\",\n \"required\": [\n \"shipment_id\",\n \"carrier_id\",\n \"service_code\",\n \"ship_to\",\n \"ship_from\"\n ],\n \"title\": \"address_validating_shipment\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"shipments\"\n ],\n \"title\": \"create_shipments_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_shipments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create Shipments\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"create_tag\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create a new tag for customizing how you track your shipments.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_tag\",\n \"parameters\": [],\n \"path\": \"/v1/tags\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A create tag request body\",\n \"properties\": {\n \"color\": {\n \"description\": \"A hex-coded string identifying the color of the tag.\",\n \"example\": \"#FF0000\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The tag name.\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"title\": \"create_tag_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_tag\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create a New Tag\",\n \"tags\": [\n \"tags\"\n ]\n },\n \"create_tag_2\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead)\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_tag_2\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"tag_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"title\": \"tag_name\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/tags/{tag_name}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"create_tag_2\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create a New Tag\",\n \"tags\": [\n \"tags\"\n ]\n },\n \"create_warehouse\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id.\\nIf the return address is not supplied in the request body then it is assumed that the origin address is the return address as well\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_warehouse\",\n \"parameters\": [],\n \"path\": \"/v1/warehouses\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A warehouse\",\n \"properties\": {\n \"created_at\": {\n \"description\": \"Timestamp that indicates when the warehouse was created\",\n \"example\": \"2019-06-25T18:12:35.583Z\",\n \"format\": \"date-time\",\n \"minLength\": 1,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"is_default\": {\n \"default\": false,\n \"description\": \"Designates which single warehouse is the default on the account\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"name\": {\n \"description\": \"Name of the warehouse\",\n \"example\": \"Zero Cool HQ\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"origin_address\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The origin address of the warehouse\"\n },\n \"return_address\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address associated with the warehouse\"\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the warehouse\",\n \"readOnly\": true\n }\n },\n \"title\": \"warehouse\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A create warehouse request body\",\n \"required\": [\n \"name\",\n \"origin_address\"\n ],\n \"title\": \"create_warehouse_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_warehouse\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create Warehouse\",\n \"tags\": [\n \"warehouses\"\n ]\n },\n \"create_webhook\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create a webhook for specific events in the environment.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"create_webhook\",\n \"parameters\": [],\n \"path\": \"/v1/environment/webhooks\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A create webhook request body\",\n \"properties\": {\n \"event\": {\n \"allOf\": [\n {\n \"description\": \"The possible webhook event values\",\n \"enum\": [\n \"batch\",\n \"carrier_connected\",\n \"order_source_refresh_complete\",\n \"rate\",\n \"report_complete\",\n \"sales_orders_imported\",\n \"track\"\n ],\n \"title\": \"webhook_event\",\n \"type\": \"string\"\n }\n ]\n },\n \"headers\": {\n \"description\": \"Array of custom webhook headers\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"Optional header to be specified in webhook\",\n \"properties\": {\n \"key\": {\n \"description\": \"Key/name of a header\",\n \"example\": \"custom-key\",\n \"min_length\": 1,\n \"title\": \"key\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"Value of a header\",\n \"example\": \"custom-value\",\n \"title\": \"value\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"key\",\n \"value\"\n ],\n \"title\": \"webhook_header\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"name\": {\n \"description\": \"The name of the webhook\",\n \"example\": \"My New Webhook\",\n \"type\": \"string\"\n },\n \"store_id\": {\n \"description\": \"Store ID\",\n \"example\": 123456,\n \"format\": \"int32\",\n \"type\": \"integer\"\n },\n \"url\": {\n \"allOf\": [\n {\n \"description\": \"A URL\",\n \"example\": \"http://api.shipengine.com/v1/labels/se-28529731\",\n \"format\": \"url\",\n \"minLength\": 1,\n \"title\": \"url\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The url that the webhook sends the request to\",\n \"example\": \"https://[YOUR ENDPOINT ID].x.requestbin.com\"\n }\n },\n \"required\": [\n \"event\",\n \"url\"\n ],\n \"title\": \"create_webhook_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"create_webhook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Create a Webhook\",\n \"tags\": [\n \"webhooks\"\n ]\n },\n \"delete_account_image_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete Account Image By Id\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_account_image_by_id\",\n \"parameters\": [\n {\n \"description\": \"Label Image Id\",\n \"in\": \"path\",\n \"name\": \"label_image_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/account/settings/images/{label_image_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"delete_account_image_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Delete Account Image By Id\",\n \"tags\": [\n \"account\"\n ]\n },\n \"delete_batch\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete Batch By Id\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_batch\",\n \"parameters\": [\n {\n \"description\": \"Batch ID\",\n \"in\": \"path\",\n \"name\": \"batch_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches/{batch_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"delete_batch\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Delete Batch By Id\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"delete_package_type\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete a custom package using the ID\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_package_type\",\n \"parameters\": [\n {\n \"description\": \"Package ID\",\n \"in\": \"path\",\n \"name\": \"package_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/packages/{package_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"delete_package_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Delete A Custom Package By ID\",\n \"tags\": [\n \"package_types\"\n ]\n },\n \"delete_scheduled_pickup\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete a previously-scheduled pickup by ID\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_scheduled_pickup\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"pickup_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Pickup Resource ID\",\n \"example\": \"pik_3YcKU5zdtJuCqoeNwyqqbW\",\n \"minLength\": 4,\n \"title\": \"pickup_resource_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/pickups/{pickup_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"delete_scheduled_pickup\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Delete a Scheduled Pickup\",\n \"tags\": [\n \"package_pickups\"\n ]\n },\n \"delete_tag\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete a tag that is no longer needed\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_tag\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"tag_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"title\": \"tag_name\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/tags/{tag_name}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"delete_tag\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Delete Tag\",\n \"tags\": [\n \"tags\"\n ]\n },\n \"delete_warehouse\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete a warehouse by ID\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_warehouse\",\n \"parameters\": [\n {\n \"description\": \"Warehouse ID\",\n \"in\": \"path\",\n \"name\": \"warehouse_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/warehouses/{warehouse_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"delete_warehouse\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Delete Warehouse By ID\",\n \"tags\": [\n \"warehouses\"\n ]\n },\n \"delete_webhook\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete a webhook\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"delete_webhook\",\n \"parameters\": [\n {\n \"description\": \"Webhook ID\",\n \"in\": \"path\",\n \"name\": \"webhook_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/environment/webhooks/{webhook_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"delete_webhook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Delete Webhook By ID\",\n \"tags\": [\n \"webhooks\"\n ]\n },\n \"disconnect_carrier\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Disconnect a carrier\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"disconnect_carrier\",\n \"parameters\": [\n {\n \"description\": \"The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.\",\n \"in\": \"path\",\n \"name\": \"carrier_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The shipping carriers that are supported by ShipEngine\",\n \"enum\": [\n \"access_worldwide\",\n \"amazon_buy_shipping\",\n \"amazon_shipping_uk\",\n \"apc\",\n \"asendia\",\n \"australia_post\",\n \"canada_post\",\n \"dhl_ecommerce\",\n \"dhl_express\",\n \"dhl_express_au\",\n \"dhl_express_ca\",\n \"dhl_express_uk\",\n \"dpd\",\n \"endicia\",\n \"fedex\",\n \"fedex_uk\",\n \"firstmile\",\n \"imex\",\n \"newgistics\",\n \"ontrac\",\n \"purolator_canada\",\n \"royal_mail\",\n \"rr_donnelley\",\n \"seko\",\n \"sendle\",\n \"stamps_com\",\n \"ups\",\n \"lasership\"\n ],\n \"title\": \"carrier_name\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/connections/carriers/{carrier_name}/{carrier_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"disconnect_carrier\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Disconnect a carrier\",\n \"tags\": [\n \"carrier_accounts\"\n ]\n },\n \"disconnect_carrier_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Disconnect a Carrier of the given ID from the account\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"disconnect_carrier_by_id\",\n \"parameters\": [\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/carriers/{carrier_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"disconnect_carrier_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Disconnect Carrier by ID\",\n \"tags\": [\n \"carriers\"\n ]\n },\n \"disconnect_insurer\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Disconnect a Shipsurance Account\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"disconnect_insurer\",\n \"parameters\": [],\n \"path\": \"/v1/connections/insurance/shipsurance\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"disconnect_insurer\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Disconnect a Shipsurance Account\",\n \"tags\": [\n \"insurance\"\n ]\n },\n \"download_file\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get File\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"download_file\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"subdir\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"filename\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"dir\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"download\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"rotation\",\n \"required\": false,\n \"schema\": {\n \"format\": \"int32\",\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/v1/downloads/{dir}/{subdir}/{filename}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"download_file\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Download File\",\n \"tags\": [\n \"downloads\"\n ]\n },\n \"estimate_rates\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Rate Estimates\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"estimate_rates\",\n \"parameters\": [],\n \"path\": \"/v1/rates/estimate\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"properties\": {\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ]\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ]\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The dimensions of the package\"\n },\n \"from_city_locality\": {\n \"description\": \"from postal code\",\n \"example\": \"Austin\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"from_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"from_postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"from_state_province\": {\n \"description\": \"From state province\",\n \"example\": \"Austin\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"ship date\",\n \"type\": \"string\"\n },\n \"to_city_locality\": {\n \"description\": \"The city locality the package is being shipped to\",\n \"example\": \"Austin\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"to_postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"to_state_province\": {\n \"description\": \"To state province\",\n \"example\": \"Houston\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the package\"\n }\n },\n \"title\": \"rate_estimate_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A rate estimate request body\",\n \"oneOf\": [\n {\n \"properties\": {\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"deprecated\": true,\n \"description\": \"A string that uniquely identifies the carrier\"\n }\n },\n \"title\": \"rate_estimate_by_carrier_id\",\n \"type\": \"object\"\n },\n {\n \"properties\": {\n \"carrier_ids\": {\n \"description\": \"Array of Carrier Ids\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"carrier id\",\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"type\": \"array\"\n }\n },\n \"title\": \"rate_estimate_by_carrier_ids\",\n \"type\": \"object\"\n }\n ],\n \"required\": [\n \"from_country_code\",\n \"from_postal_code\",\n \"from_city_locality\",\n \"from_state_province\",\n \"to_country_code\",\n \"to_postal_code\",\n \"to_city_locality\",\n \"to_state_province\",\n \"weight\",\n \"ship_date\"\n ],\n \"title\": \"estimate_rates_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"estimate_rates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Estimate Rates\",\n \"tags\": [\n \"rates\"\n ]\n },\n \"get_account_settings_images_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve information for an account image.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_account_settings_images_by_id\",\n \"parameters\": [\n {\n \"description\": \"Label Image Id\",\n \"in\": \"path\",\n \"name\": \"label_image_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/account/settings/images/{label_image_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_account_settings_images_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Account Image By ID\",\n \"tags\": [\n \"account\"\n ]\n },\n \"get_batch_by_external_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Batch By External ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_batch_by_external_id\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"external_batch_id\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches/external_batch_id/{external_batch_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_batch_by_external_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Batch By External ID\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"get_batch_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Batch By ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_batch_by_id\",\n \"parameters\": [\n {\n \"description\": \"Batch ID\",\n \"in\": \"path\",\n \"name\": \"batch_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches/{batch_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_batch_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Batch By ID\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"get_carrier_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrive carrier info by ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_carrier_by_id\",\n \"parameters\": [\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/carriers/{carrier_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_carrier_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Carrier By ID\",\n \"tags\": [\n \"carriers\"\n ]\n },\n \"get_carrier_options\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get a list of the options available for the carrier\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_carrier_options\",\n \"parameters\": [\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/carriers/{carrier_id}/options\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_carrier_options\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Carrier Options\",\n \"tags\": [\n \"carriers\"\n ]\n },\n \"get_carrier_settings\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get carrier settings\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_carrier_settings\",\n \"parameters\": [\n {\n \"description\": \"The carrier name, such as `ups`, `fedex`, or `dhl_express`.\",\n \"in\": \"path\",\n \"name\": \"carrier_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The shipping carriers for which ShipEngine supports carrier settings\",\n \"enum\": [\n \"dhl_express\",\n \"fedex\",\n \"newgistics\",\n \"ups\"\n ],\n \"title\": \"carrier_name_with_settings\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/connections/carriers/{carrier_name}/{carrier_id}/settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_carrier_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get carrier settings\",\n \"tags\": [\n \"carrier_accounts\"\n ]\n },\n \"get_insurance_balance\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve the balance of your Shipsurance account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_insurance_balance\",\n \"parameters\": [],\n \"path\": \"/v1/insurance/shipsurance/balance\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_insurance_balance\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Insurance Funds Balance\",\n \"tags\": [\n \"insurance\"\n ]\n },\n \"get_label_by_external_shipment_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Find a label by using the external shipment id that was used during label creation\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_label_by_external_shipment_id\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"external_shipment_id\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"label_download_type\",\n \"required\": false,\n \"schema\": {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/external_shipment_id/{external_shipment_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_label_by_external_shipment_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Label By External Shipment ID\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"get_label_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve information for individual labels.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_label_by_id\",\n \"parameters\": [\n {\n \"description\": \"Label ID\",\n \"in\": \"path\",\n \"name\": \"label_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"label_download_type\",\n \"required\": false,\n \"schema\": {\n \"description\": \"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\\n\\n|Label Download Type | Description\\n|--------------------|------------------------------\\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.\\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\\n\",\n \"enum\": [\n \"url\",\n \"inline\"\n ],\n \"title\": \"label_download_type\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/{label_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_label_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Label By ID\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"get_manifest_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Manifest By Id\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_manifest_by_id\",\n \"parameters\": [\n {\n \"description\": \"The Manifest Id\",\n \"in\": \"path\",\n \"name\": \"manifest_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/manifests/{manifest_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_manifest_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Manifest By Id\",\n \"tags\": [\n \"manifests\"\n ]\n },\n \"get_manifest_request_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Manifest Request By Id\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_manifest_request_by_id\",\n \"parameters\": [\n {\n \"description\": \"The Manifest Request Id\",\n \"in\": \"path\",\n \"name\": \"manifest_request_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/manifests/requests/{manifest_request_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_manifest_request_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Manifest Request By Id\",\n \"tags\": [\n \"manifests\"\n ]\n },\n \"get_package_type_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Custom Package Type by ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_package_type_by_id\",\n \"parameters\": [\n {\n \"description\": \"Package ID\",\n \"in\": \"path\",\n \"name\": \"package_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/packages/{package_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_package_type_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Custom Package Type By ID\",\n \"tags\": [\n \"package_types\"\n ]\n },\n \"get_pickup_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Pickup By ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_pickup_by_id\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"pickup_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Pickup Resource ID\",\n \"example\": \"pik_3YcKU5zdtJuCqoeNwyqqbW\",\n \"minLength\": 4,\n \"title\": \"pickup_resource_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/pickups/{pickup_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_pickup_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Pickup By ID\",\n \"tags\": [\n \"package_pickups\"\n ]\n },\n \"get_rate_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve a previously queried rate by its ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_rate_by_id\",\n \"parameters\": [\n {\n \"description\": \"Rate ID\",\n \"in\": \"path\",\n \"name\": \"rate_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/rates/{rate_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_rate_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Rate By ID\",\n \"tags\": [\n \"rates\"\n ]\n },\n \"get_shipment_by_external_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Query Shipments created using your own custom ID convention using this endpint\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_shipment_by_external_id\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"external_shipment_id\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/external_shipment_id/{external_shipment_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_shipment_by_external_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Shipment By External ID\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"get_shipment_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get an individual shipment based on its ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_shipment_by_id\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/{shipment_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_shipment_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Shipment By ID\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"get_tracking_log\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve package tracking information\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_tracking_log\",\n \"parameters\": [\n {\n \"description\": \"A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\\n\",\n \"in\": \"query\",\n \"name\": \"carrier_code\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The tracking number associated with a shipment\",\n \"in\": \"query\",\n \"name\": \"tracking_number\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Carrier ID\",\n \"in\": \"query\",\n \"name\": \"carrier_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/tracking\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_tracking_log\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Tracking Information\",\n \"tags\": [\n \"tracking\"\n ]\n },\n \"get_tracking_log_from_label\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve the label's tracking information\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_tracking_log_from_label\",\n \"parameters\": [\n {\n \"description\": \"Label ID\",\n \"in\": \"path\",\n \"name\": \"label_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/{label_id}/track\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_tracking_log_from_label\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Label Tracking Information\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"get_warehouse_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve warehouse data based on the warehouse ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_warehouse_by_id\",\n \"parameters\": [\n {\n \"description\": \"Warehouse ID\",\n \"in\": \"path\",\n \"name\": \"warehouse_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/warehouses/{warehouse_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_warehouse_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Warehouse By Id\",\n \"tags\": [\n \"warehouses\"\n ]\n },\n \"get_webhook_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve individual webhook by an ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"get_webhook_by_id\",\n \"parameters\": [\n {\n \"description\": \"Webhook ID\",\n \"in\": \"path\",\n \"name\": \"webhook_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/environment/webhooks/{webhook_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"get_webhook_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Webhook By ID\",\n \"tags\": [\n \"webhooks\"\n ]\n },\n \"list_account_images\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List all account images for the ShipEngine account\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_account_images\",\n \"parameters\": [],\n \"path\": \"/v1/account/settings/images\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_account_images\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Account Images\",\n \"tags\": [\n \"account\"\n ]\n },\n \"list_account_settings\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List all account settings for the ShipEngine account\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_account_settings\",\n \"parameters\": [],\n \"path\": \"/v1/account/settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_account_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Account Settings\",\n \"tags\": [\n \"account\"\n ]\n },\n \"list_batch_errors\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Error handling in batches are handled differently than in a single synchronous request.\\nYou must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_batch_errors\",\n \"parameters\": [\n {\n \"description\": \"Batch ID\",\n \"in\": \"path\",\n \"name\": \"batch_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\\n\",\n \"in\": \"query\",\n \"name\": \"page\",\n \"required\": false,\n \"schema\": {\n \"default\": 1,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"pagesize\",\n \"required\": false,\n \"schema\": {\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/v1/batches/{batch_id}/errors\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_batch_errors\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Batch Errors\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"list_batches\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List Batches associated with your Shipengine account\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_batches\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"description\": \"The possible batch status values\",\n \"enum\": [\n \"open\",\n \"queued\",\n \"processing\",\n \"completed\",\n \"completed_with_errors\",\n \"archived\",\n \"notifying\",\n \"invalid\"\n ],\n \"title\": \"batch_status\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\\n\",\n \"in\": \"query\",\n \"name\": \"page\",\n \"required\": false,\n \"schema\": {\n \"default\": 1,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The number of results to return per response.\",\n \"in\": \"query\",\n \"name\": \"page_size\",\n \"required\": false,\n \"schema\": {\n \"default\": 25,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Controls the sort order of the query.\",\n \"in\": \"query\",\n \"name\": \"sort_dir\",\n \"required\": false,\n \"schema\": {\n \"allOf\": [\n {\n \"description\": \"Controls the sort order of queries\\n\\n|Value |Description\\n|:---------|:-----------------------------------------------------\\n|`asc` |Return results in ascending order\\n|`desc` |Return results in descending order\\n\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ],\n \"title\": \"sort_dir\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"desc\"\n }\n },\n {\n \"description\": \"Batch Number\",\n \"in\": \"query\",\n \"name\": \"batch_number\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return batches that were created on or after a specific date/time\",\n \"in\": \"query\",\n \"name\": \"created_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return batches that were created on or before a specific date/time\",\n \"in\": \"query\",\n \"name\": \"created_at_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return batches that were processed on or after a specific date/time\",\n \"in\": \"query\",\n \"name\": \"processed_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return batches that were processed on or before a specific date/time\",\n \"in\": \"query\",\n \"name\": \"processed_at_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"sort_by\",\n \"required\": false,\n \"schema\": {\n \"description\": \"The possible batches sort by values\",\n \"enum\": [\n \"ship_date\",\n \"processed_at\",\n \"created_at\"\n ],\n \"title\": \"batches_sort_by\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_batches\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Batches\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"list_carrier_package_types\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List the package types associated with the carrier\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_carrier_package_types\",\n \"parameters\": [\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/carriers/{carrier_id}/packages\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_carrier_package_types\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Carrier Package Types\",\n \"tags\": [\n \"carriers\"\n ]\n },\n \"list_carrier_services\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List the services associated with the carrier ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_carrier_services\",\n \"parameters\": [\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/carriers/{carrier_id}/services\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_carrier_services\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Carrier Services\",\n \"tags\": [\n \"carriers\"\n ]\n },\n \"list_carriers\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List all carriers that have been added to this account\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_carriers\",\n \"parameters\": [],\n \"path\": \"/v1/carriers\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_carriers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Carriers\",\n \"tags\": [\n \"carriers\"\n ]\n },\n \"list_labels\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time.\\n\\nBy default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_labels\",\n \"parameters\": [\n {\n \"description\": \"Only return labels that are currently in the specified status\",\n \"in\": \"query\",\n \"name\": \"label_status\",\n \"required\": false,\n \"schema\": {\n \"description\": \"The possible statuses that a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) can be in.\\n\\n|Status |Description\\n|:------------|:-----------------------------------------------------\\n|`processing` |When labels are created in a [batch](https://www.shipengine.com/docs/labels/bulk/), it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in `processing` status.\\n|`completed` |The label was successfully created\\n|`error` |The label could not be created due to an error, such as an invalid delivery address\\n|`voided` |The label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\\n\",\n \"enum\": [\n \"processing\",\n \"completed\",\n \"error\",\n \"voided\"\n ],\n \"title\": \"label_status\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)\",\n \"in\": \"query\",\n \"name\": \"service_code\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\",\n \"example\": \"usps_first_class_mail\",\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9-]+)* ?$\",\n \"title\": \"service_code\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)\",\n \"in\": \"query\",\n \"name\": \"carrier_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels with a specific tracking number\",\n \"in\": \"query\",\n \"name\": \"tracking_number\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)\",\n \"in\": \"query\",\n \"name\": \"batch_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Rate ID\",\n \"in\": \"query\",\n \"name\": \"rate_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Shipment ID\",\n \"in\": \"query\",\n \"name\": \"shipment_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)\",\n \"in\": \"query\",\n \"name\": \"warehouse_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels that were created on or after a specific date/time\",\n \"in\": \"query\",\n \"name\": \"created_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels that were created on or before a specific date/time\",\n \"in\": \"query\",\n \"name\": \"created_at_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return labels with specific refund status/es.\",\n \"in\": \"query\",\n \"name\": \"refund_status\",\n \"required\": false,\n \"schema\": {\n \"items\": {\n \"description\": \"The status of a Refund Assist request for eligible labels.\\n\\n|Status |Description\\n|:-------------------|:-----------------------------------------------------\\n|`request_scheduled` |The refund request has been scheduled but not yet submitted\\n|`pending` |The refund request has been submitted and is awaiting approval\\n|`approved` |The refund request has been approved by the carrier\\n|`rejected` |The refund request has been rejected by the carrier\\n|`excluded` |The refund request has been excluded by the user. Labels in this status were not sent to the carrier for a refund request.\\n\",\n \"enum\": [\n \"request_scheduled\",\n \"pending\",\n \"approved\",\n \"rejected\",\n \"excluded\"\n ],\n \"title\": \"refund_status\",\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n },\n {\n \"description\": \"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\\n\",\n \"in\": \"query\",\n \"name\": \"page\",\n \"required\": false,\n \"schema\": {\n \"default\": 1,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The number of results to return per response.\",\n \"in\": \"query\",\n \"name\": \"page_size\",\n \"required\": false,\n \"schema\": {\n \"default\": 25,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Controls the sort order of the query.\",\n \"in\": \"query\",\n \"name\": \"sort_dir\",\n \"required\": false,\n \"schema\": {\n \"allOf\": [\n {\n \"description\": \"Controls the sort order of queries\\n\\n|Value |Description\\n|:---------|:-----------------------------------------------------\\n|`asc` |Return results in ascending order\\n|`desc` |Return results in descending order\\n\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ],\n \"title\": \"sort_dir\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"desc\"\n }\n },\n {\n \"description\": \"Controls which field the query is sorted by.\",\n \"in\": \"query\",\n \"name\": \"sort_by\",\n \"required\": false,\n \"schema\": {\n \"default\": \"created_at\",\n \"enum\": [\n \"modified_at\",\n \"created_at\",\n \"voided_at\"\n ],\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_labels\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List labels\",\n \"tags\": [\n \"labels\"\n ]\n },\n \"list_manifests\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_manifests\",\n \"parameters\": [\n {\n \"description\": \"Warehouse ID\",\n \"in\": \"query\",\n \"name\": \"warehouse_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ship date start range\",\n \"in\": \"query\",\n \"name\": \"ship_date_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"ship date end range\",\n \"in\": \"query\",\n \"name\": \"ship_date_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)\",\n \"in\": \"query\",\n \"name\": \"created_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)\",\n \"in\": \"query\",\n \"name\": \"created_at_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Carrier ID\",\n \"in\": \"query\",\n \"name\": \"carrier_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\\n\",\n \"in\": \"query\",\n \"name\": \"page\",\n \"required\": false,\n \"schema\": {\n \"default\": 1,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The number of results to return per response.\",\n \"in\": \"query\",\n \"name\": \"page_size\",\n \"required\": false,\n \"schema\": {\n \"default\": 25,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"label_ids\",\n \"required\": false,\n \"schema\": {\n \"description\": \"Array of label ids\",\n \"items\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n }\n ],\n \"path\": \"/v1/manifests\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_manifests\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Manifests\",\n \"tags\": [\n \"manifests\"\n ]\n },\n \"list_package_types\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List the custom package types associated with the account\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_package_types\",\n \"parameters\": [],\n \"path\": \"/v1/packages\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_package_types\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Custom Package Types\",\n \"tags\": [\n \"package_types\"\n ]\n },\n \"list_scheduled_pickups\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List all pickups that have been scheduled for this carrier\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_scheduled_pickups\",\n \"parameters\": [\n {\n \"description\": \"Carrier ID\",\n \"in\": \"query\",\n \"name\": \"carrier_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Warehouse ID\",\n \"in\": \"query\",\n \"name\": \"warehouse_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return scheduled pickups that were created on or after a specific date/time\",\n \"in\": \"query\",\n \"name\": \"created_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Only return scheduled pickups that were created on or before a specific date/time\",\n \"in\": \"query\",\n \"name\": \"created_at_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\\n\",\n \"in\": \"query\",\n \"name\": \"page\",\n \"required\": false,\n \"schema\": {\n \"default\": 1,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The number of results to return per response.\",\n \"in\": \"query\",\n \"name\": \"page_size\",\n \"required\": false,\n \"schema\": {\n \"default\": 25,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n }\n ],\n \"path\": \"/v1/pickups\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_scheduled_pickups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Scheduled Pickups\",\n \"tags\": [\n \"package_pickups\"\n ]\n },\n \"list_shipment_rates\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Rates for the shipment information associated with the shipment ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_shipment_rates\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)\",\n \"in\": \"query\",\n \"name\": \"created_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/{shipment_id}/rates\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_shipment_rates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Shipment Rates\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"list_shipments\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get list of Shipments\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_shipments\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"shipment_status\",\n \"required\": false,\n \"schema\": {\n \"description\": \"The possible shipment status values\",\n \"enum\": [\n \"pending\",\n \"processing\",\n \"label_purchased\",\n \"cancelled\"\n ],\n \"title\": \"shipment_status\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Batch ID\",\n \"in\": \"query\",\n \"name\": \"batch_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Search for shipments based on the custom tag added to the shipment object\",\n \"in\": \"query\",\n \"name\": \"tag\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)\",\n \"in\": \"query\",\n \"name\": \"created_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)\",\n \"in\": \"query\",\n \"name\": \"created_at_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)\",\n \"in\": \"query\",\n \"name\": \"modified_at_start\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)\",\n \"in\": \"query\",\n \"name\": \"modified_at_end\",\n \"required\": false,\n \"schema\": {\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\\n\",\n \"in\": \"query\",\n \"name\": \"page\",\n \"required\": false,\n \"schema\": {\n \"default\": 1,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"The number of results to return per response.\",\n \"in\": \"query\",\n \"name\": \"page_size\",\n \"required\": false,\n \"schema\": {\n \"default\": 25,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"type\": \"integer\"\n }\n },\n {\n \"description\": \"Sales Order ID\",\n \"in\": \"query\",\n \"name\": \"sales_order_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Controls the sort order of the query.\",\n \"in\": \"query\",\n \"name\": \"sort_dir\",\n \"required\": false,\n \"schema\": {\n \"allOf\": [\n {\n \"description\": \"Controls the sort order of queries\\n\\n|Value |Description\\n|:---------|:-----------------------------------------------------\\n|`asc` |Return results in ascending order\\n|`desc` |Return results in descending order\\n\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ],\n \"title\": \"sort_dir\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"desc\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"sort_by\",\n \"required\": false,\n \"schema\": {\n \"description\": \"The possible shipments sort by values\",\n \"enum\": [\n \"modified_at\",\n \"created_at\"\n ],\n \"title\": \"shipments_sort_by\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_shipments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Shipments\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"list_tags\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get a list of all tags associated with an account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_tags\",\n \"parameters\": [],\n \"path\": \"/v1/tags\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_tags\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Tags\",\n \"tags\": [\n \"tags\"\n ]\n },\n \"list_warehouses\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieve a list of warehouses associated with this account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_warehouses\",\n \"parameters\": [],\n \"path\": \"/v1/warehouses\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_warehouses\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Warehouses\",\n \"tags\": [\n \"warehouses\"\n ]\n },\n \"list_webhooks\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List all webhooks currently enabled for the account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"list_webhooks\",\n \"parameters\": [],\n \"path\": \"/v1/environment/webhooks\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"list_webhooks\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Webhooks\",\n \"tags\": [\n \"webhooks\"\n ]\n },\n \"parse_address\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more.\\n\\nData often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels.\\n\\n> **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"parse_address\",\n \"parameters\": [],\n \"path\": \"/v1/addresses/recognize\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.\\n\",\n \"properties\": {\n \"address\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"You can optionally provide any already-known address values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.\\n\"\n },\n \"text\": {\n \"description\": \"The unstructured text that contains address-related entities\",\n \"example\": \"Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652.\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"text\"\n ],\n \"title\": \"parse_address_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"parse_address\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Parse an address\",\n \"tags\": [\n \"addresses\"\n ]\n },\n \"parse_shipment\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more.\\n\\nData often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label.\\n\\n> **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"parse_shipment\",\n \"parameters\": [],\n \"path\": \"/v1/shipments/recognize\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.\\n\",\n \"properties\": {\n \"shipment\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\\n\",\n \"properties\": {\n \"advanced_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": true,\n \"description\": \"Advanced shipment options\",\n \"properties\": {\n \"additional_handling\": {\n \"default\": null,\n \"description\": \"Indicate to the carrier that this shipment requires additional handling.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"bill_to_account\": {\n \"default\": null,\n \"description\": \"This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bill_to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true\n },\n \"bill_to_party\": {\n \"allOf\": [\n {\n \"description\": \"The possible bill to party values\",\n \"enum\": [\n \"recipient\",\n \"third_party\"\n ],\n \"title\": \"bill_to_party\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\\n\",\n \"nullable\": true\n },\n \"bill_to_postal_code\": {\n \"default\": null,\n \"description\": \"The postal code of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"certificate_number\": {\n \"default\": null,\n \"description\": \"certificate_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 784515,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"collect_on_delivery\": {\n \"description\": \"Defer payment until package is delivered, instead of when it is ordered.\",\n \"properties\": {\n \"payment_amount\": {\n \"properties\": {\n \"amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"payment_amount\",\n \"type\": \"object\"\n },\n \"payment_type\": {\n \"allOf\": [\n {\n \"description\": \"Types of payment that are supported\",\n \"enum\": [\n \"any\",\n \"cash\",\n \"cash_equivalent\",\n \"none\"\n ],\n \"title\": \"collect_on_delivery_payment_type\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"collect_on_delivery\",\n \"type\": \"object\"\n },\n \"contains_alcohol\": {\n \"default\": false,\n \"description\": \"Indicates that the shipment contains alcohol.\",\n \"type\": \"boolean\"\n },\n \"custom_field1\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_goods\": {\n \"default\": false,\n \"description\": \"Indicates if the Dangerous goods are present in the shipment\",\n \"type\": \"boolean\"\n },\n \"dangerous_goods_contact\": {\n \"description\": \"Contact information for Dangerous goods\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the contact\",\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number of the contact\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"delivered_duty_paid\": {\n \"default\": false,\n \"description\": \"Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\\n\",\n \"type\": \"boolean\"\n },\n \"delivery-as-addressed\": {\n \"default\": false,\n \"description\": \"Instructs the carrier to deliver the package only to the exact address provided.\",\n \"type\": \"boolean\"\n },\n \"dry_ice\": {\n \"default\": false,\n \"description\": \"Indicates if the shipment contain dry ice\",\n \"type\": \"boolean\"\n },\n \"dry_ice_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the dry ice in the shipment\",\n \"nullable\": true\n },\n \"fedex_freight\": {\n \"description\": \"Provide details for the Fedex freight service\",\n \"properties\": {\n \"booking_confirmation\": {\n \"type\": \"string\"\n },\n \"shipper_load_and_count\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"fragile\": {\n \"default\": false,\n \"description\": \"Indicates that the contents of the package are fragile and should be handled with care.\",\n \"type\": \"boolean\"\n },\n \"freight_class\": {\n \"default\": null,\n \"description\": \"The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \\\"77.5\\\", \\\"110\\\", or \\\"250\\\".\\n\",\n \"example\": 77.5,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"default\": null,\n \"description\": \"invoice_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": \"IOC56888\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"license_number\": {\n \"default\": null,\n \"description\": \"license_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 514785,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"non_machinable\": {\n \"default\": false,\n \"description\": \"Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\\n\",\n \"type\": \"boolean\"\n },\n \"origin_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates if the package will be picked up or dropped off by the carrier\",\n \"enum\": [\n \"pickup\",\n \"drop_off\"\n ],\n \"title\": \"origin_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"nullable\": true\n },\n \"regulated_content_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"enum\": [\n \"day_old_poultry\",\n \"other_live_animal\"\n ],\n \"title\": \"regulated_content_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"nullable\": true\n },\n \"return-after-first-attempt\": {\n \"default\": false,\n \"description\": \"Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.\",\n \"type\": \"boolean\"\n },\n \"saturday_delivery\": {\n \"default\": false,\n \"description\": \"Enables Saturday delivery, if supported by the carrier.\",\n \"type\": \"boolean\"\n },\n \"shipper_release\": {\n \"default\": null,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"third_party_consignee\": {\n \"default\": false,\n \"description\": \"Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached\",\n \"type\": \"boolean\"\n },\n \"use_ups_ground_freight_pricing\": {\n \"default\": null,\n \"description\": \"Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"windsor_framework_details\": {\n \"description\": \"The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.\",\n \"properties\": {\n \"movement_indicator\": {\n \"description\": \"An indicator that will tell the carrier and HMRC the type of movement for the shipment.\",\n \"enum\": [\n \"c2c\",\n \"b2c\",\n \"c2b\",\n \"b2b\"\n ],\n \"type\": \"string\"\n },\n \"not_at_risk\": {\n \"description\": \"An indicator that allows a shipper to declare the shipment as not-at-risk.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"title\": \"advanced_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Advanced shipment options. These are entirely optional.\"\n },\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The carrier account that is billed for the shipping charges\"\n },\n \"comparison_rate_type\": {\n \"description\": \"Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.\",\n \"example\": \"retail\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The type of delivery confirmation that is required for this shipment.\"\n },\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"customs\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Options for international shipments, such as customs declarations.\",\n \"properties\": {\n \"certificate_number\": {\n \"description\": \"The certificate number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"contents\": {\n \"allOf\": [\n {\n \"description\": \"The possible package contents values\",\n \"enum\": [\n \"merchandise\",\n \"documents\",\n \"gift\",\n \"returned_goods\",\n \"sample\",\n \"other\"\n ],\n \"title\": \"package_contents\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"merchandise\",\n \"description\": \"The type of contents in this shipment. This may impact import duties or customs treatment.\"\n },\n \"contents_explanation\": {\n \"description\": \"Explanation for contents (required if the `contents` is provided as `other`)\",\n \"type\": \"string\"\n },\n \"customs_items\": {\n \"default\": [],\n \"deprecated\": true,\n \"description\": \"Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"customs_item_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the customs item\",\n \"readOnly\": true\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the customs item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"value_currency\": {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"required\": [\n \"customs_item_id\"\n ],\n \"title\": \"customs_item\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"declaration\": {\n \"description\": \"Declaration statement to be placed on the commercial invoice\",\n \"type\": \"string\"\n },\n \"importer_of_record\": {\n \"allOf\": [\n {\n \"description\": \"importer of records address, anywhere in the world.\\n\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"postal_code\",\n \"country_code\"\n ],\n \"title\": \"importer_of_records\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"invoice_additional_details\": {\n \"allOf\": [\n {\n \"description\": \"The additional information to put on commercial invoice \\n\",\n \"properties\": {\n \"discount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Discount for shipment.\"\n },\n \"estimated_import_charges\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\\n\",\n \"properties\": {\n \"duties\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import duties.\"\n },\n \"taxes\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import taxes.\"\n }\n },\n \"title\": \"estimated_import_charges\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\"\n },\n \"freight_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Freight Charge for shipment.\"\n },\n \"insurance_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Insurance Charge for shipment.\"\n },\n \"invoice_number\": {\n \"description\": \"The invoice number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"other_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Other charge for shipment.\"\n },\n \"other_charge_description\": {\n \"description\": \"Description for the other charge (if provided).\",\n \"type\": \"string\"\n }\n },\n \"title\": \"invoice_additional_details\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"license_number\": {\n \"description\": \"The license number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"non_delivery\": {\n \"allOf\": [\n {\n \"description\": \"The possible non delivery values\",\n \"enum\": [\n \"return_to_sender\",\n \"treat_as_abandoned\"\n ],\n \"title\": \"non_delivery\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"return_to_sender\",\n \"description\": \"Indicates what to do if a package is unable to be delivered.\"\n },\n \"terms_of_trade_code\": {\n \"allOf\": [\n {\n \"enum\": [\n \"exw\",\n \"fca\",\n \"cpt\",\n \"cip\",\n \"dpu\",\n \"dap\",\n \"ddp\",\n \"fas\",\n \"fob\",\n \"cfr\",\n \"cif\",\n \"ddu\",\n \"daf\",\n \"deq\",\n \"des\"\n ],\n \"title\": \"Allowed incoterms\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Specifies the supported terms of trade code (incoterms)\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"contents\",\n \"non_delivery\"\n ],\n \"title\": \"international_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"default\": null,\n \"description\": \"Customs information. This is usually only needed for international shipments.\\n\",\n \"nullable\": true\n },\n \"external_order_id\": {\n \"description\": \"ID that the Order Source assigned\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_shipment_id\": {\n \"description\": \"A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\\n\\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"insurance_provider\": {\n \"allOf\": [\n {\n \"description\": \"The possible insurance provider values\",\n \"enum\": [\n \"none\",\n \"shipsurance\",\n \"carrier\",\n \"third_party\"\n ],\n \"title\": \"insurance_provider\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The insurance provider to use for any insured packages in the shipment.\\n\"\n },\n \"is_return\": {\n \"default\": false,\n \"description\": \"An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"items\": {\n \"default\": [],\n \"description\": \"Describe the packages included in this shipment as related to potential metadata that was imported from\\nexternal order sources\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A shipment item\",\n \"properties\": {\n \"asin\": {\n \"description\": \"Amazon Standard Identification Number\",\n \"example\": \"B00005N5PF\",\n \"maxLength\": 10,\n \"minLength\": 10,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bundle_sku\": {\n \"description\": \"Item Stock Keeping Unit of the product bundle\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"external_order_id\": {\n \"description\": \"external order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_order_item_id\": {\n \"description\": \"external order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"item name\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"quantity\": {\n \"description\": \"The quantity of this item included in the shipment\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sales_order_id\": {\n \"description\": \"sales order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sales_order_item_id\": {\n \"description\": \"sales order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku\": {\n \"description\": \"Item Stock Keeping Unit\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"shipment_item\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created or last modified.\",\n \"readOnly\": true\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"packages\": {\n \"description\": \"The packages in the shipment.\\n\\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package associated with a shipment\\n\",\n \"properties\": {\n \"content_description\": {\n \"description\": \"A short description of the package content. Required for shipments moving to, from, and through Mexico.\\n\",\n \"example\": \"Hand knitted wool socks\",\n \"maxLength\": 35,\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n },\n \"external_package_id\": {\n \"description\": \"An external package id.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"insured_value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"default\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"description\": \"The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\\n\"\n },\n \"label_messages\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\\n\\n|Carrier |Max lines |Max line length\\n|-------------------|----------|--------------------\\n|USPS (Stamps.com) |3 |60\\n|FedEx |3 |35 for the first line. 30 for additional lines.\\n|UPS |2 |35\\n|OnTrac |2 |25\\n\",\n \"properties\": {\n \"reference1\": {\n \"default\": null,\n \"description\": \"The first line of the custom label message. Some carriers may prefix this line with something like \\\"REF\\\", \\\"Reference\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference2\": {\n \"default\": null,\n \"description\": \"The second line of the custom label message. Some carriers may prefix this line with something like \\\"INV\\\", \\\"Reference 2\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference3\": {\n \"default\": null,\n \"description\": \"The third line of the custom label message. Some carriers may prefix this line with something like \\\"PO\\\", \\\"Reference 3\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"reference1\",\n \"reference2\",\n \"reference3\"\n ],\n \"title\": \"label_messages\",\n \"type\": \"object\"\n }\n ]\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\\n\"\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\"\n },\n \"package_name\": {\n \"description\": \"The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\",\n \"type\": \"string\"\n },\n \"products\": {\n \"default\": [],\n \"description\": \"Details about products inside packages (Information provided would be used on custom documentation)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"dangerous_goods\": {\n \"default\": [],\n \"description\": \"Details about dangerous goods inside products\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"Dangerous goods attribute associated with the product\\n\",\n \"properties\": {\n \"additional_description\": {\n \"default\": null,\n \"description\": \"Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_amount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"This model represents the amount of the dangerous goods..\",\n \"properties\": {\n \"amount\": {\n \"default\": 0,\n \"description\": \"The amount of dangerous goods.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"default\": null,\n \"description\": \"The unit of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_amount\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"This model represents the amount of the dangerous goods.\"\n },\n \"id_number\": {\n \"default\": null,\n \"description\": \"UN number to identify the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_group\": {\n \"enum\": [\n \"i\",\n \"ii\",\n \"iii\"\n ],\n \"title\": \"packaging_group\",\n \"type\": \"string\"\n },\n \"packaging_instruction\": {\n \"default\": null,\n \"description\": \"The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_instruction_section\": {\n \"enum\": [\n \"section_1\",\n \"section_2\",\n \"section_1a\",\n \"section_1b\"\n ],\n \"title\": \"packaging_instruction_section\",\n \"type\": \"string\"\n },\n \"packaging_type\": {\n \"default\": null,\n \"description\": \"The type of exterior packaging used to contain the dangerous good.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class\": {\n \"default\": null,\n \"description\": \"Dangerous goods product class based on regulation.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class_subsidiary\": {\n \"default\": null,\n \"description\": \"A secondary of product class for substances presenting more than one particular hazard\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"Quantity of dangerous goods.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"radioactive\": {\n \"description\": \"Indication if the substance is radioactive.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"regulation_authority\": {\n \"default\": null,\n \"description\": \"Name of the regulatory authority.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"regulation_level\": {\n \"enum\": [\n \"lightly_regulated\",\n \"fully_regulated\",\n \"limited_quantities\",\n \"excepted_quantity\"\n ],\n \"title\": \"regulation_level\",\n \"type\": \"string\"\n },\n \"reportable_quantity\": {\n \"description\": \"Indication if the substance needs to be reported to regulatory authority based on the quantity.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"shipping_name\": {\n \"default\": null,\n \"description\": \"Trade description of the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"technical_name\": {\n \"default\": null,\n \"description\": \"Recognized Technical or chemical name of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_category\": {\n \"default\": null,\n \"description\": \"Transport category assign to dangerous goods for the transport purpose.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_mean\": {\n \"enum\": [\n \"ground\",\n \"water\",\n \"cargo_aircraft_only\",\n \"passenger_aircraft\"\n ],\n \"title\": \"transport_mean\",\n \"type\": \"string\"\n },\n \"tunnel_code\": {\n \"default\": null,\n \"description\": \"Defines which types of tunnels the shipment is allowed to go through\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_goods\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"extended_details\": {\n \"additionalProperties\": true,\n \"description\": \"Additional details about products\",\n \"type\": \"object\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"mid_code\": {\n \"description\": \"Manufacturers Identification code\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_url\": {\n \"description\": \"link to the item on the seller website\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The declared value of each item\"\n },\n \"vat_rate\": {\n \"description\": \"VAT rate applicable to the item\",\n \"example\": 0.2,\n \"nullable\": true,\n \"type\": \"number\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"title\": \"products\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"shipment_package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this shipment package\",\n \"readOnly\": true\n },\n \"tracking_number\": {\n \"allOf\": [\n {\n \"description\": \"A tracking number for a package. The format depends on the carrier.\",\n \"example\": \"1Z932R800392060079\",\n \"minLength\": 1,\n \"title\": \"tracking_number\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The tracking number for the package. The format depends on the carrier.\\n\",\n \"readOnly\": true\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package weight\"\n }\n },\n \"required\": [\n \"weight\"\n ],\n \"title\": \"package\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"return_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address for this shipment. Defaults to the `ship_from` address.\\n\"\n },\n \"service_code\": {\n \"allOf\": [\n {\n \"description\": \"A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\",\n \"example\": \"usps_first_class_mail\",\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9-]+)* ?$\",\n \"title\": \"service_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\\n\",\n \"example\": \"2018-09-23T00:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}(T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2}))?$\",\n \"title\": \"date\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\\n\"\n },\n \"ship_from\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\\n\"\n },\n \"ship_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"geolocation\": {\n \"items\": {\n \"properties\": {\n \"type\": {\n \"description\": \"Enum of available type of geolocation items:\\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\\n\",\n \"enum\": [\n \"what3words\"\n ],\n \"example\": \"what3words\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"value of the geolocation item\",\n \"example\": \"cats.with.thumbs\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The recipient's mailing address\"\n },\n \"shipment_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the shipment\",\n \"readOnly\": true\n },\n \"shipment_number\": {\n \"description\": \"A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\\n\\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment_status\": {\n \"allOf\": [\n {\n \"description\": \"The possible shipment status values\",\n \"enum\": [\n \"pending\",\n \"processing\",\n \"label_purchased\",\n \"cancelled\"\n ],\n \"title\": \"shipment_status\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pending\",\n \"description\": \"The current status of the shipment\",\n \"readOnly\": true\n },\n \"shipping_rule_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\\n\"\n },\n \"tags\": {\n \"default\": [],\n \"description\": \"Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"properties\": {\n \"color\": {\n \"description\": \"A hex-coded string identifying the color of the tag.\",\n \"example\": \"#FF0000\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The tag name.\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"tag_id\": {\n \"description\": \"An integer uniquely identifying a tag.\",\n \"example\": 8712,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"title\": \"tag\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 0,\n \"readOnly\": true,\n \"type\": \"array\"\n },\n \"tax_identifiers\": {\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A tax identifier object\",\n \"properties\": {\n \"identifier_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type | Description\\n|---------------|-----------------------------------------\\n|`vat` | The tax identifier is a Value Added Tax.\\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\\n|`ssn` | The tax identifier is a Social Security Number.\\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\\n|`passport` | The tax identifier is a Passport Number.\\n|`abn` | The tax identifier is an Australian Business Number.\\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\\n\",\n \"enum\": [\n \"vat\",\n \"eori\",\n \"ssn\",\n \"ein\",\n \"tin\",\n \"ioss\",\n \"pan\",\n \"voec\",\n \"pccc\",\n \"oss\",\n \"passport\",\n \"abn\",\n \"ukims\"\n ],\n \"title\": \"identifier_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"issuing_authority\": {\n \"description\": \"The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.\",\n \"type\": \"string\"\n },\n \"taxable_entity_type\": {\n \"allOf\": [\n {\n \"description\": \"The taxable entity type for this tax item. Valid values include the following\\n\\n|Value |Description\\n|:--------- |:-----------------------------------------------------\\n|`shipper` | The shipper is responsible for this tax.\\n|`recipient` | The recipient of the shipment is responsible for this tax.\\n|`ior` | The importer of records is responsible for tax.\\n\",\n \"enum\": [\n \"shipper\",\n \"recipient\",\n \"ior\"\n ],\n \"title\": \"taxable_entity_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The value of the identifier\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"taxable_entity_type\",\n \"identifier_type\",\n \"issuing_authority\",\n \"value\"\n ],\n \"title\": \"tax_identifier\",\n \"type\": \"object\"\n }\n ]\n },\n \"nullable\": true,\n \"type\": \"array\"\n },\n \"total_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The combined weight of all packages in the shipment\",\n \"readOnly\": true\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\\n\",\n \"nullable\": true\n },\n \"zone\": {\n \"description\": \"Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\\ncustom zones that vary depending upon the ship_to and ship_from location\\n\",\n \"example\": 6,\n \"format\": \"int32\",\n \"minimum\": 0,\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"title\": \"partial_shipment\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"You can optionally provide a `shipment` object containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.\\n\"\n },\n \"text\": {\n \"description\": \"The unstructured text that contains shipping-related entities\",\n \"example\": \"I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400.\\n\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"text\"\n ],\n \"title\": \"parse_shipment_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"parse_shipment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Parse shipping info\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"process_batch\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Process Batch ID Labels\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"process_batch\",\n \"parameters\": [\n {\n \"description\": \"Batch ID\",\n \"in\": \"path\",\n \"name\": \"batch_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches/{batch_id}/process/labels\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"A process batch request body\",\n \"properties\": {\n \"display_scheme\": {\n \"allOf\": [\n {\n \"description\": \"The display format that the label should be shown in.\",\n \"enum\": [\n \"label\",\n \"paperless\",\n \"label_and_paperless\"\n ],\n \"title\": \"display_scheme\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"label\",\n \"description\": \"The display format that the label should be shown in.\"\n },\n \"label_format\": {\n \"allOf\": [\n {\n \"description\": \"The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\\n\\n|Label Format | Supported Carriers\\n|--------------|-----------------------------------\\n|`pdf` | All carriers\\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\\n\",\n \"enum\": [\n \"pdf\",\n \"png\",\n \"zpl\"\n ],\n \"title\": \"label_format\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pdf\"\n },\n \"label_layout\": {\n \"allOf\": [\n {\n \"description\": \"The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\\\" x 11\\\") is only supported for `pdf` format.\\n\",\n \"enum\": [\n \"4x6\",\n \"letter\",\n \"A4\",\n \"A6\"\n ],\n \"title\": \"label_layout\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"4x6\",\n \"type\": \"string\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The Ship date the batch is being processed for\"\n }\n },\n \"title\": \"process_batch_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"process_batch\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Process Batch ID Labels\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"remove_from_batch\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Remove a shipment or rate from a batch\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"remove_from_batch\",\n \"parameters\": [\n {\n \"description\": \"Batch ID\",\n \"in\": \"path\",\n \"name\": \"batch_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches/{batch_id}/remove\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A modify batch object\",\n \"properties\": {\n \"rate_ids\": {\n \"description\": \"Array of Rate IDs to be modifed on the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The Rate ID to be modified on the batch\"\n },\n \"type\": \"array\"\n },\n \"shipment_ids\": {\n \"description\": \"The Shipment Ids to be modified on the batch\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The Shipment ID to be modified on the batch\"\n },\n \"type\": \"array\"\n }\n },\n \"title\": \"modify_batch\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A modify batch request body\",\n \"title\": \"remove_from_batch_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"remove_from_batch\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Remove From Batch\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"rename_tag\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Change a tag name while still keeping the relevant shipments attached to it\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"rename_tag\",\n \"parameters\": [\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"tag_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"title\": \"tag_name\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"new_tag_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"title\": \"tag_name\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/tags/{tag_name}/{new_tag_name}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"rename_tag\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Tag Name\",\n \"tags\": [\n \"tags\"\n ]\n },\n \"schedule_pickup\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Schedule a package pickup with a carrier\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"schedule_pickup\",\n \"parameters\": [],\n \"path\": \"/v1/pickups\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to schedule a package pickup\\n\",\n \"properties\": {\n \"cancelled_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the pickup was cancelled in ShipEngine.\",\n \"readOnly\": true\n },\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The carrier_id associated with the pickup\",\n \"readOnly\": true\n },\n \"confirmation_number\": {\n \"description\": \"The carrier confirmation number for the scheduled pickup.\",\n \"example\": \"292513CL4A3\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"contact_details\": {\n \"properties\": {\n \"email\": {\n \"allOf\": [\n {\n \"description\": \"An email address.\",\n \"example\": \"john.doe@example.com\",\n \"format\": \"email\",\n \"minLength\": 1,\n \"title\": \"email\",\n \"type\": \"string\"\n }\n ]\n },\n \"name\": {\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number associated\",\n \"minLength\": 7,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"email\",\n \"phone\"\n ],\n \"title\": \"contact_details\",\n \"type\": \"object\"\n },\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the pickup was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"label_ids\": {\n \"description\": \"Label IDs that will be included in the pickup request\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Label ID that will be included in the pickup request\"\n },\n \"type\": \"array\"\n },\n \"pickup_address\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n }\n ],\n \"readOnly\": true\n },\n \"pickup_id\": {\n \"allOf\": [\n {\n \"description\": \"Pickup Resource ID\",\n \"example\": \"pik_3YcKU5zdtJuCqoeNwyqqbW\",\n \"minLength\": 4,\n \"title\": \"pickup_resource_id\",\n \"type\": \"string\"\n }\n ],\n \"readOnly\": true\n },\n \"pickup_notes\": {\n \"description\": \"Used by some carriers to give special instructions for a package pickup\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"pickup_window\": {\n \"description\": \"The desired time range for the package pickup.\",\n \"properties\": {\n \"end_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ]\n },\n \"start_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"start_at\",\n \"end_at\"\n ],\n \"title\": \"pickup_window\",\n \"type\": \"object\",\n \"writeOnly\": true\n },\n \"pickup_windows\": {\n \"description\": \"An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"properties\": {\n \"end_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ]\n },\n \"start_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"pickup_windows\",\n \"type\": \"object\"\n }\n ]\n },\n \"readOnly\": true,\n \"type\": \"array\"\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The warehouse_id associated with the pickup\",\n \"readOnly\": true\n }\n },\n \"title\": \"pickup\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A schedule pickup request body\",\n \"required\": [\n \"contact_details\",\n \"label_ids\",\n \"pickup_window\"\n ],\n \"title\": \"schedule_pickup_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"schedule_pickup\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Schedule a Pickup\",\n \"tags\": [\n \"package_pickups\"\n ]\n },\n \"service_points_get_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a carrier service point by using the service_point_id\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"service_points_get_by_id\",\n \"parameters\": [\n {\n \"description\": \"Carrier code\",\n \"in\": \"path\",\n \"name\": \"carrier_code\",\n \"required\": true,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"in\": \"path\",\n \"name\": \"country_code\",\n \"required\": true,\n \"schema\": {\n \"maxLength\": 2,\n \"minLength\": 2,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"service_point_id\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/service_points/{carrier_code}/{country_code}/{service_point_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"service_points_get_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Service Point By ID\",\n \"tags\": [\n \"service_points\"\n ]\n },\n \"service_points_list\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"List carrier service points by location\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"service_points_list\",\n \"parameters\": [],\n \"path\": \"/v1/service_points/list\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"description\": \"A get service points request body. Caller must provide exactly one of address_query, address, or lat / long pair.\",\n \"properties\": {\n \"address\": {\n \"description\": \"Structured address to search by.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ],\n \"type\": \"string\"\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"country_code\"\n ],\n \"type\": \"object\"\n },\n \"address_query\": {\n \"description\": \"Unstructured text to search for service points by.\",\n \"example\": \"177A Bleecker Street New York\",\n \"type\": \"string\"\n },\n \"lat\": {\n \"description\": \"The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html\",\n \"example\": 48.874518928233094,\n \"format\": \"double\",\n \"type\": \"number\"\n },\n \"long\": {\n \"description\": \"The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html\",\n \"example\": 2.3591775711639404,\n \"format\": \"double\",\n \"type\": \"number\"\n },\n \"max_results\": {\n \"description\": \"The maximum number of service points to return\",\n \"example\": 25,\n \"format\": \"int32\",\n \"type\": \"integer\"\n },\n \"providers\": {\n \"description\": \"An array of shipping service providers and service codes\",\n \"items\": {\n \"properties\": {\n \"carrier_id\": {\n \"description\": \"Uniquely identifies a carrier connection\",\n \"example\": \"se-123456\",\n \"type\": \"string\"\n },\n \"service_code\": {\n \"items\": {\n \"description\": \"Uniquely identifies a shipping service\",\n \"example\": \"chronoclassic\",\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"radius\": {\n \"description\": \"Search radius in kilometers\",\n \"example\": 500,\n \"format\": \"int32\",\n \"type\": \"integer\"\n },\n \"shipment\": {\n \"description\": \"Shipment information to be used for service point selection\",\n \"properties\": {\n \"packages\": {\n \"description\": \"An array of package dimensions\",\n \"items\": {\n \"properties\": {\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"total_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Shipment total weight\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"providers\"\n ],\n \"title\": \"get_service_points_request_body\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"get_service_points_request\"\n },\n \"security\": null,\n \"skill_name\": \"service_points_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"List Service Points\",\n \"tags\": [\n \"service_points\"\n ]\n },\n \"shipments_list_tags\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Get Shipment tags based on its ID\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"shipments_list_tags\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/{shipment_id}/tags\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"shipments_list_tags\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Shipment Tags\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"shipments_update_tags\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update Shipments Tags\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"shipments_update_tags\",\n \"parameters\": [],\n \"path\": \"/v1/shipments/tags\",\n \"request_body\": {\n \"allOf\": [\n {\n \"example\": {\n \"shipments_tags\": [\n {\n \"shipment_id\": \"se-1014296\",\n \"tags\": [\n \"Fragile\",\n \"International\"\n ]\n },\n {\n \"shipment_id\": \"se-1014297\",\n \"tags\": [\n \"Fragile\",\n \"International\"\n ]\n }\n ]\n },\n \"properties\": {\n \"shipments_tags\": {\n \"items\": {\n \"properties\": {\n \"shipment_id\": {\n \"type\": \"string\"\n },\n \"tags\": {\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n }\n },\n \"title\": \"update_shipments_tags\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A request body with shipments and tags\",\n \"title\": \"update_shipments_tags_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"shipments_update_tags\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Shipments Tags\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"start_tracking\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package,\\nand receive notifications via webhooks whenever the shipping status changes.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"start_tracking\",\n \"parameters\": [\n {\n \"description\": \"A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\\n\",\n \"in\": \"query\",\n \"name\": \"carrier_code\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The tracking number associated with a shipment\",\n \"in\": \"query\",\n \"name\": \"tracking_number\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Carrier ID\",\n \"in\": \"query\",\n \"name\": \"carrier_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/tracking/start\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"start_tracking\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Start Tracking a Package\",\n \"tags\": [\n \"tracking\"\n ]\n },\n \"stop_tracking\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Unsubscribe from tracking updates for a package.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"stop_tracking\",\n \"parameters\": [\n {\n \"description\": \"A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\\n\",\n \"in\": \"query\",\n \"name\": \"carrier_code\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The tracking number associated with a shipment\",\n \"in\": \"query\",\n \"name\": \"tracking_number\",\n \"required\": false,\n \"schema\": {\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Carrier ID\",\n \"in\": \"query\",\n \"name\": \"carrier_id\",\n \"required\": false,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/tracking/stop\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"stop_tracking\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Stop Tracking a Package\",\n \"tags\": [\n \"tracking\"\n ]\n },\n \"tag_shipment\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Add a tag to the shipment object\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"tag_shipment\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"tag_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"title\": \"tag_name\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/{shipment_id}/tags/{tag_name}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tag_shipment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Add Tag to Shipment\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"tokens_get_ephemeral_token\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"tokens_get_ephemeral_token\",\n \"parameters\": [\n {\n \"description\": \"Include a redirect url to the application formatted with the ephemeral token.\",\n \"in\": \"query\",\n \"name\": \"redirect\",\n \"required\": false,\n \"schema\": {\n \"description\": \"The resource to return a redirect URL to.\",\n \"enum\": [\n \"shipengine-dashboard\"\n ],\n \"title\": \"redirect\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/tokens/ephemeral\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tokens_get_ephemeral_token\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Get Ephemeral Token\",\n \"tags\": [\n \"tokens\"\n ]\n },\n \"untag_shipment\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Remove an existing tag from the Shipment object\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"untag_shipment\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"tag_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"title\": \"tag_name\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/{shipment_id}/tags/{tag_name}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"untag_shipment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Remove Tag from Shipment\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"update_account_settings_images_by_id\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update information for an account image.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_account_settings_images_by_id\",\n \"parameters\": [\n {\n \"description\": \"Label Image Id\",\n \"in\": \"path\",\n \"name\": \"label_image_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/account/settings/images/{label_image_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A ShipEngine account images body\",\n \"properties\": {\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the image was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"image_content_type\": {\n \"allOf\": [\n {\n \"description\": \"The image type\",\n \"enum\": [\n \"image/png\",\n \"image/jpeg\"\n ],\n \"type\": \"string\"\n }\n ],\n \"description\": \"The file type of the image. \\n\"\n },\n \"image_data\": {\n \"description\": \"A base64 encoded string representation of the image.\\n\",\n \"example\": \"iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==\",\n \"type\": \"string\"\n },\n \"is_default\": {\n \"description\": \"Indicates whether this image is set as default.\\n\",\n \"example\": false,\n \"type\": \"boolean\"\n },\n \"label_image_id\": {\n \"allOf\": [\n {\n \"description\": \"Used to identify an image resource.\",\n \"example\": \"img_DtBXupDBxREpHnwEXhTfgK\",\n \"minLength\": 4,\n \"title\": \"image_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\\n\",\n \"readOnly\": true\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the image was modified in ShipEngine.\",\n \"readOnly\": true\n },\n \"name\": {\n \"description\": \"A human readable name for the image.\\n\",\n \"example\": \"My logo\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"account_settings_images\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"A ShipEngine account settings images request body\",\n \"required\": [\n \"is_default\"\n ],\n \"title\": \"update_account_settings_image_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"update_account_settings_images_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Account Image By ID\",\n \"tags\": [\n \"account\"\n ]\n },\n \"update_batch\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update Batch By Id\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_batch\",\n \"parameters\": [\n {\n \"description\": \"Batch ID\",\n \"in\": \"path\",\n \"name\": \"batch_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/batches/{batch_id}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"update_batch\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Batch By Id\",\n \"tags\": [\n \"batches\"\n ]\n },\n \"update_carrier_settings\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update carrier settings\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_carrier_settings\",\n \"parameters\": [\n {\n \"description\": \"The carrier name, such as `ups`, `fedex`, or `dhl_express`.\",\n \"in\": \"path\",\n \"name\": \"carrier_name\",\n \"required\": true,\n \"schema\": {\n \"description\": \"The shipping carriers for which ShipEngine supports carrier settings\",\n \"enum\": [\n \"dhl_express\",\n \"fedex\",\n \"newgistics\",\n \"ups\"\n ],\n \"title\": \"carrier_name_with_settings\",\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Carrier ID\",\n \"in\": \"path\",\n \"name\": \"carrier_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/connections/carriers/{carrier_name}/{carrier_id}/settings\",\n \"request_body\": {\n \"oneOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A DHL Express account settings\",\n \"properties\": {\n \"is_primary_account\": {\n \"description\": \"Indicates if this is primary account\",\n \"type\": \"boolean\"\n },\n \"nickname\": {\n \"description\": \"Account nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"should_hide_account_number_on_archive_doc\": {\n \"description\": \"Indicates if the account number should be hidden on the archive documentation\",\n \"type\": \"boolean\"\n }\n },\n \"title\": \"dhl_express_account_settings\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An update dhl express settings request body\",\n \"title\": \"update_dhl_express_settings_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A Fedex account settings request body\",\n \"properties\": {\n \"is_primary_account\": {\n \"type\": \"boolean\"\n },\n \"letterhead_image\": {\n \"type\": \"string\"\n },\n \"nickname\": {\n \"description\": \"Account nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"pickup_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type |Description\\n|--------------------------|-----------------------------------------\\n|`none` | Not specified\\n|`regular_pickup` | You already have a daily pickup scheduled with FedEx\\n|`request_courier` | You will call FedEx to request a courier\\n|`drop_box` | You will drop-off packages in a FedEx drop box\\n|`business_service_center` | You will drop-off packages at an authorized FedEx business service center\\n|`station` | You will drop-off the package at a FedEx Station\\n\",\n \"enum\": [\n \"none\",\n \"regular_pickup\",\n \"request_courier\",\n \"drop_box\",\n \"business_service_center\",\n \"station\"\n ],\n \"title\": \"fedex_pickup_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"signature_image\": {\n \"type\": \"string\"\n },\n \"smart_post_endorsement\": {\n \"allOf\": [\n {\n \"description\": \"[Ancillary service endorsements](https://pe.usps.com/text/qsg300/Q507.htm) are used by mailers to request an addressee's new address and to provide the carrier with instructions on how to handle packages that are undeliverable as addressed.\\n\\n| Ancillary Service Endorsement | Description\\n|--------------------------------|-----------------------------------------------------\\n| `none` | No ancillary service is requested. Depending on the carrier servive, the package may be forwarded, returned, or discarded.\\n| `return_service_requested` | The package is returned to the sender. If possible, notification of the new address is is included with the returned package.\\n| `forwarding_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender.\\n| `address_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. This is similar to `forwarding_service_requested`, but different restrictions and charges may apply.\\n| `change_service_requested` | The package is discarded. If possible, notification of the new address is sent to the sender.\\n| `leave_if_no_response` |\\n\",\n \"enum\": [\n \"none\",\n \"return_service_requested\",\n \"forwarding_service_requested\",\n \"address_service_requested\",\n \"change_service_requested\",\n \"leave_if_no_response\"\n ],\n \"title\": \"ancillary_service_endorsement\",\n \"type\": \"string\"\n }\n ]\n },\n \"smart_post_hub\": {\n \"allOf\": [\n {\n \"description\": \"The possible smart post hub values\",\n \"enum\": [\n \"none\",\n \"allentown_pa\",\n \"atlanta_ga\",\n \"baltimore_md\",\n \"charlotte_nc\",\n \"chino_ca\",\n \"dallas_tx\",\n \"denver_co\",\n \"detroit_mi\",\n \"edison_nj\",\n \"grove_city_oh\",\n \"groveport_oh\",\n \"houston_tx\",\n \"indianapolis_in\",\n \"kansas_city_ks\",\n \"los_angeles_ca\",\n \"martinsburg_wv\",\n \"memphis_tn\",\n \"minneapolis_mn\",\n \"new_berlin_wi\",\n \"northborough_ma\",\n \"orlando_fl\",\n \"phoneix_az\",\n \"pittsburgh_pa\",\n \"reno_nv\",\n \"sacramento_ca\",\n \"salt_lake_city_ut\",\n \"seattle_wa\",\n \"st_louis_mo\",\n \"windsor_ct\",\n \"newark_ny\",\n \"south_brunswick_nj\",\n \"scranton_pa\",\n \"wheeling_il\",\n \"middletown_ct\",\n \"portland_or\"\n ],\n \"title\": \"smart_post_hub\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"fedex_account_settings\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An update Fedex settings request body\",\n \"title\": \"update_fedex_settings_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A newgistics account settings request body\",\n \"properties\": {\n \"include_barcode_with_order_number\": {\n \"type\": \"boolean\"\n },\n \"receive_email_on_manifest_processing\": {\n \"type\": \"boolean\"\n }\n },\n \"title\": \"update_newgistics_settings_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"UPS account settings\",\n \"properties\": {\n \"account_postal_code\": {\n \"description\": \"account postal code\",\n \"minLength\": 5,\n \"type\": \"string\"\n },\n \"invoice\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"UPS invoice\",\n \"properties\": {\n \"control_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the control\"\n },\n \"invoice_amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"invoice_currency_code\": {\n \"type\": \"string\"\n },\n \"invoice_date\": {\n \"description\": \"invoice date\",\n \"format\": \"date-time\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"description\": \"invoice number\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"ups_invoice\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The invoice\"\n },\n \"is_primary_account\": {\n \"description\": \"Indicates if this is the primary UPS account\",\n \"type\": \"boolean\"\n },\n \"mail_innovations_cost_center\": {\n \"description\": \"mail innovations cost center\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"mail_innovations_endorsement\": {\n \"allOf\": [\n {\n \"description\": \"[Ancillary service endorsements](https://pe.usps.com/text/qsg300/Q507.htm) are used by mailers to request an addressee's new address and to provide the carrier with instructions on how to handle packages that are undeliverable as addressed.\\n\\n| Ancillary Service Endorsement | Description\\n|--------------------------------|-----------------------------------------------------\\n| `none` | No ancillary service is requested. Depending on the carrier servive, the package may be forwarded, returned, or discarded.\\n| `return_service_requested` | The package is returned to the sender. If possible, notification of the new address is is included with the returned package.\\n| `forwarding_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender.\\n| `address_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. This is similar to `forwarding_service_requested`, but different restrictions and charges may apply.\\n| `change_service_requested` | The package is discarded. If possible, notification of the new address is sent to the sender.\\n| `leave_if_no_response` |\\n\",\n \"enum\": [\n \"none\",\n \"return_service_requested\",\n \"forwarding_service_requested\",\n \"address_service_requested\",\n \"change_service_requested\",\n \"leave_if_no_response\"\n ],\n \"title\": \"ancillary_service_endorsement\",\n \"type\": \"string\"\n }\n ]\n },\n \"nickname\": {\n \"description\": \"nickname\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"pickup_type\": {\n \"allOf\": [\n {\n \"description\": \"The possible ups pickup type values\",\n \"enum\": [\n \"daily_pickup\",\n \"occasional_pickup\",\n \"customer_counter\"\n ],\n \"title\": \"ups_pickup_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"use_carbon_neutral_shipping_program\": {\n \"description\": \"The use carbon neutral shipping program\",\n \"type\": \"boolean\"\n },\n \"use_consolidation_services\": {\n \"description\": \"The use consolidation services\",\n \"type\": \"boolean\"\n },\n \"use_ground_freight_pricing\": {\n \"description\": \"The use ground freight pricing\",\n \"type\": \"boolean\"\n },\n \"use_negotiated_rates\": {\n \"description\": \"The use negotiated rates\",\n \"type\": \"boolean\"\n },\n \"use_order_number_on_mail_innovations_labels\": {\n \"description\": \"The use order number on mail innovations labels\",\n \"type\": \"boolean\"\n }\n },\n \"title\": \"ups_account_settings\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An update UPS settings request body\",\n \"title\": \"update_ups_settings_request_body\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"An amazon buy shipping account settings request body\",\n \"properties\": {\n \"email\": {\n \"description\": \"Email\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"update_amazon_buy_shipping_request_body\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"update_carrier_settings_request_body\"\n },\n \"security\": null,\n \"skill_name\": \"update_carrier_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update carrier settings\",\n \"tags\": [\n \"carrier_accounts\"\n ]\n },\n \"update_package_type\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update the custom package type object by ID\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_package_type\",\n \"parameters\": [\n {\n \"description\": \"Package ID\",\n \"in\": \"path\",\n \"name\": \"package_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/packages/{package_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package type that a carrier supports for shipment.\",\n \"properties\": {\n \"description\": {\n \"description\": \"Provides a helpful description for the custom package.\",\n \"example\": \"Packaging for laptops\",\n \"maxLength\": 500,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The custom dimensions for the package.\"\n },\n \"name\": {\n \"example\": \"laptop_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the package.\"\n }\n },\n \"required\": [\n \"name\",\n \"package_code\"\n ],\n \"title\": \"package_type\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An update package type request body\",\n \"title\": \"update_package_type_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"update_package_type\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Custom Package Type By ID\",\n \"tags\": [\n \"package_types\"\n ]\n },\n \"update_shipment\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update a shipment object based on its ID\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_shipment\",\n \"parameters\": [\n {\n \"description\": \"Shipment ID\",\n \"in\": \"path\",\n \"name\": \"shipment_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/shipments/{shipment_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\\n\",\n \"properties\": {\n \"advanced_options\": {\n \"allOf\": [\n {\n \"additionalProperties\": true,\n \"description\": \"Advanced shipment options\",\n \"properties\": {\n \"additional_handling\": {\n \"default\": null,\n \"description\": \"Indicate to the carrier that this shipment requires additional handling.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"bill_to_account\": {\n \"default\": null,\n \"description\": \"This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bill_to_country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true\n },\n \"bill_to_party\": {\n \"allOf\": [\n {\n \"description\": \"The possible bill to party values\",\n \"enum\": [\n \"recipient\",\n \"third_party\"\n ],\n \"title\": \"bill_to_party\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\\n\",\n \"nullable\": true\n },\n \"bill_to_postal_code\": {\n \"default\": null,\n \"description\": \"The postal code of the third-party that is responsible for shipping costs.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"certificate_number\": {\n \"default\": null,\n \"description\": \"certificate_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 784515,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"collect_on_delivery\": {\n \"description\": \"Defer payment until package is delivered, instead of when it is ordered.\",\n \"properties\": {\n \"payment_amount\": {\n \"properties\": {\n \"amount\": {\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"payment_amount\",\n \"type\": \"object\"\n },\n \"payment_type\": {\n \"allOf\": [\n {\n \"description\": \"Types of payment that are supported\",\n \"enum\": [\n \"any\",\n \"cash\",\n \"cash_equivalent\",\n \"none\"\n ],\n \"title\": \"collect_on_delivery_payment_type\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"title\": \"collect_on_delivery\",\n \"type\": \"object\"\n },\n \"contains_alcohol\": {\n \"default\": false,\n \"description\": \"Indicates that the shipment contains alcohol.\",\n \"type\": \"boolean\"\n },\n \"custom_field1\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field2\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"custom_field3\": {\n \"default\": null,\n \"description\": \"An arbitrary field that can be used to store information about the shipment.\\n\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_goods\": {\n \"default\": false,\n \"description\": \"Indicates if the Dangerous goods are present in the shipment\",\n \"type\": \"boolean\"\n },\n \"dangerous_goods_contact\": {\n \"description\": \"Contact information for Dangerous goods\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the contact\",\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"Phone number of the contact\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"delivered_duty_paid\": {\n \"default\": false,\n \"description\": \"Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\\n\",\n \"type\": \"boolean\"\n },\n \"delivery-as-addressed\": {\n \"default\": false,\n \"description\": \"Instructs the carrier to deliver the package only to the exact address provided.\",\n \"type\": \"boolean\"\n },\n \"dry_ice\": {\n \"default\": false,\n \"description\": \"Indicates if the shipment contain dry ice\",\n \"type\": \"boolean\"\n },\n \"dry_ice_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The weight of the dry ice in the shipment\",\n \"nullable\": true\n },\n \"fedex_freight\": {\n \"description\": \"Provide details for the Fedex freight service\",\n \"properties\": {\n \"booking_confirmation\": {\n \"type\": \"string\"\n },\n \"shipper_load_and_count\": {\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"fragile\": {\n \"default\": false,\n \"description\": \"Indicates that the contents of the package are fragile and should be handled with care.\",\n \"type\": \"boolean\"\n },\n \"freight_class\": {\n \"default\": null,\n \"description\": \"The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \\\"77.5\\\", \\\"110\\\", or \\\"250\\\".\\n\",\n \"example\": 77.5,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"invoice_number\": {\n \"default\": null,\n \"description\": \"invoice_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": \"IOC56888\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"license_number\": {\n \"default\": null,\n \"description\": \"license_number - This field was part of a historical implementation for passing customs-related data. For new integrations, please use the corresponding parameters within the shipment.customs object.\",\n \"example\": 514785,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"non_machinable\": {\n \"default\": false,\n \"description\": \"Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\\n\",\n \"type\": \"boolean\"\n },\n \"origin_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates if the package will be picked up or dropped off by the carrier\",\n \"enum\": [\n \"pickup\",\n \"drop_off\"\n ],\n \"title\": \"origin_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"nullable\": true\n },\n \"regulated_content_type\": {\n \"allOf\": [\n {\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"enum\": [\n \"day_old_poultry\",\n \"other_live_animal\"\n ],\n \"title\": \"regulated_content_type\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.\",\n \"nullable\": true\n },\n \"return-after-first-attempt\": {\n \"default\": false,\n \"description\": \"Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.\",\n \"type\": \"boolean\"\n },\n \"saturday_delivery\": {\n \"default\": false,\n \"description\": \"Enables Saturday delivery, if supported by the carrier.\",\n \"type\": \"boolean\"\n },\n \"shipper_release\": {\n \"default\": null,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"third_party_consignee\": {\n \"default\": false,\n \"description\": \"Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached\",\n \"type\": \"boolean\"\n },\n \"use_ups_ground_freight_pricing\": {\n \"default\": null,\n \"description\": \"Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"windsor_framework_details\": {\n \"description\": \"The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.\",\n \"properties\": {\n \"movement_indicator\": {\n \"description\": \"An indicator that will tell the carrier and HMRC the type of movement for the shipment.\",\n \"enum\": [\n \"c2c\",\n \"b2c\",\n \"c2b\",\n \"b2b\"\n ],\n \"type\": \"string\"\n },\n \"not_at_risk\": {\n \"description\": \"An indicator that allows a shipper to declare the shipment as not-at-risk.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"title\": \"advanced_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Advanced shipment options. These are entirely optional.\"\n },\n \"carrier_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The carrier account that is billed for the shipping charges\"\n },\n \"comparison_rate_type\": {\n \"description\": \"Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.\",\n \"example\": \"retail\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"confirmation\": {\n \"allOf\": [\n {\n \"description\": \"The possible delivery confirmation values\",\n \"enum\": [\n \"none\",\n \"delivery\",\n \"signature\",\n \"adult_signature\",\n \"direct_signature\",\n \"delivery_mailed\",\n \"verbal_confirmation\",\n \"delivery_code\",\n \"age_verification_16_plus\"\n ],\n \"title\": \"delivery_confirmation\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The type of delivery confirmation that is required for this shipment.\"\n },\n \"created_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created in ShipEngine.\",\n \"readOnly\": true\n },\n \"customs\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Options for international shipments, such as customs declarations.\",\n \"properties\": {\n \"certificate_number\": {\n \"description\": \"The certificate number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"contents\": {\n \"allOf\": [\n {\n \"description\": \"The possible package contents values\",\n \"enum\": [\n \"merchandise\",\n \"documents\",\n \"gift\",\n \"returned_goods\",\n \"sample\",\n \"other\"\n ],\n \"title\": \"package_contents\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"merchandise\",\n \"description\": \"The type of contents in this shipment. This may impact import duties or customs treatment.\"\n },\n \"contents_explanation\": {\n \"description\": \"Explanation for contents (required if the `contents` is provided as `other`)\",\n \"type\": \"string\"\n },\n \"customs_items\": {\n \"default\": [],\n \"deprecated\": true,\n \"description\": \"Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"customs_item_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the customs item\",\n \"readOnly\": true\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the customs item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"value_currency\": {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"required\": [\n \"customs_item_id\"\n ],\n \"title\": \"customs_item\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"declaration\": {\n \"description\": \"Declaration statement to be placed on the commercial invoice\",\n \"type\": \"string\"\n },\n \"importer_of_record\": {\n \"allOf\": [\n {\n \"description\": \"importer of records address, anywhere in the world.\\n\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"postal_code\",\n \"country_code\"\n ],\n \"title\": \"importer_of_records\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"invoice_additional_details\": {\n \"allOf\": [\n {\n \"description\": \"The additional information to put on commercial invoice \\n\",\n \"properties\": {\n \"discount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Discount for shipment.\"\n },\n \"estimated_import_charges\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\\n\",\n \"properties\": {\n \"duties\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import duties.\"\n },\n \"taxes\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import taxes.\"\n }\n },\n \"title\": \"estimated_import_charges\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Estimated import charges for commercial invoices for international shipments.\"\n },\n \"freight_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Freight Charge for shipment.\"\n },\n \"insurance_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Insurance Charge for shipment.\"\n },\n \"invoice_number\": {\n \"description\": \"The invoice number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"other_charge\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Other charge for shipment.\"\n },\n \"other_charge_description\": {\n \"description\": \"Description for the other charge (if provided).\",\n \"type\": \"string\"\n }\n },\n \"title\": \"invoice_additional_details\",\n \"type\": \"object\"\n }\n ],\n \"type\": \"object\"\n },\n \"license_number\": {\n \"description\": \"The license number to be used in the customs.\",\n \"type\": \"string\"\n },\n \"non_delivery\": {\n \"allOf\": [\n {\n \"description\": \"The possible non delivery values\",\n \"enum\": [\n \"return_to_sender\",\n \"treat_as_abandoned\"\n ],\n \"title\": \"non_delivery\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"return_to_sender\",\n \"description\": \"Indicates what to do if a package is unable to be delivered.\"\n },\n \"terms_of_trade_code\": {\n \"allOf\": [\n {\n \"enum\": [\n \"exw\",\n \"fca\",\n \"cpt\",\n \"cip\",\n \"dpu\",\n \"dap\",\n \"ddp\",\n \"fas\",\n \"fob\",\n \"cfr\",\n \"cif\",\n \"ddu\",\n \"daf\",\n \"deq\",\n \"des\"\n ],\n \"title\": \"Allowed incoterms\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"Specifies the supported terms of trade code (incoterms)\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"contents\",\n \"non_delivery\"\n ],\n \"title\": \"international_shipment_options\",\n \"type\": \"object\"\n }\n ],\n \"default\": null,\n \"description\": \"Customs information. This is usually only needed for international shipments.\\n\",\n \"nullable\": true\n },\n \"external_order_id\": {\n \"description\": \"ID that the Order Source assigned\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_shipment_id\": {\n \"description\": \"A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\\n\\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"insurance_provider\": {\n \"allOf\": [\n {\n \"description\": \"The possible insurance provider values\",\n \"enum\": [\n \"none\",\n \"shipsurance\",\n \"carrier\",\n \"third_party\"\n ],\n \"title\": \"insurance_provider\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"none\",\n \"description\": \"The insurance provider to use for any insured packages in the shipment.\\n\"\n },\n \"is_return\": {\n \"default\": false,\n \"description\": \"An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\\n\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"items\": {\n \"default\": [],\n \"description\": \"Describe the packages included in this shipment as related to potential metadata that was imported from\\nexternal order sources\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A shipment item\",\n \"properties\": {\n \"asin\": {\n \"description\": \"Amazon Standard Identification Number\",\n \"example\": \"B00005N5PF\",\n \"maxLength\": 10,\n \"minLength\": 10,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"bundle_sku\": {\n \"description\": \"Item Stock Keeping Unit of the product bundle\",\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"external_order_id\": {\n \"description\": \"external order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_order_item_id\": {\n \"description\": \"external order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"item name\",\n \"minLength\": 0,\n \"type\": \"string\"\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"quantity\": {\n \"description\": \"The quantity of this item included in the shipment\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sales_order_id\": {\n \"description\": \"sales order id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sales_order_item_id\": {\n \"description\": \"sales order item id\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku\": {\n \"description\": \"Item Stock Keeping Unit\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"shipment_item\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"modified_at\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\\n\",\n \"example\": \"2018-09-23T15:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2})$\",\n \"title\": \"date_time\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date and time that the shipment was created or last modified.\",\n \"readOnly\": true\n },\n \"order_source_code\": {\n \"allOf\": [\n {\n \"description\": \"The order sources that are supported by ShipEngine\",\n \"enum\": [\n \"amazon_ca\",\n \"amazon_us\",\n \"brightpearl\",\n \"channel_advisor\",\n \"cratejoy\",\n \"ebay\",\n \"etsy\",\n \"jane\",\n \"groupon_goods\",\n \"magento\",\n \"paypal\",\n \"seller_active\",\n \"shopify\",\n \"stitch_labs\",\n \"squarespace\",\n \"three_dcart\",\n \"tophatter\",\n \"walmart\",\n \"woo_commerce\",\n \"volusion\"\n ],\n \"title\": \"order_source_name\",\n \"type\": \"string\"\n }\n ]\n },\n \"packages\": {\n \"description\": \"The packages in the shipment.\\n\\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A package associated with a shipment\\n\",\n \"properties\": {\n \"content_description\": {\n \"description\": \"A short description of the package content. Required for shipments moving to, from, and through Mexico.\\n\",\n \"example\": \"Hand knitted wool socks\",\n \"maxLength\": 35,\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dimensions\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The dimensions of a package\",\n \"properties\": {\n \"height\": {\n \"default\": 0,\n \"description\": \"The height of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"length\": {\n \"default\": 0,\n \"description\": \"The length of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The dimension units that are supported by ShipEngine.\",\n \"enum\": [\n \"inch\",\n \"centimeter\"\n ],\n \"title\": \"dimension_unit\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"inch\"\n },\n \"width\": {\n \"default\": 0,\n \"description\": \"The width of the package, in the specified unit\",\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"unit\",\n \"length\",\n \"width\",\n \"height\"\n ],\n \"title\": \"dimensions\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package dimensions\"\n },\n \"external_package_id\": {\n \"description\": \"An external package id.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"insured_value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"default\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"description\": \"The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\\n\"\n },\n \"label_messages\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\\n\\n|Carrier |Max lines |Max line length\\n|-------------------|----------|--------------------\\n|USPS (Stamps.com) |3 |60\\n|FedEx |3 |35 for the first line. 30 for additional lines.\\n|UPS |2 |35\\n|OnTrac |2 |25\\n\",\n \"properties\": {\n \"reference1\": {\n \"default\": null,\n \"description\": \"The first line of the custom label message. Some carriers may prefix this line with something like \\\"REF\\\", \\\"Reference\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference2\": {\n \"default\": null,\n \"description\": \"The second line of the custom label message. Some carriers may prefix this line with something like \\\"INV\\\", \\\"Reference 2\\\", \\\"Trx Ref No.\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"reference3\": {\n \"default\": null,\n \"description\": \"The third line of the custom label message. Some carriers may prefix this line with something like \\\"PO\\\", \\\"Reference 3\\\", etc.\\n\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"reference1\",\n \"reference2\",\n \"reference3\"\n ],\n \"title\": \"label_messages\",\n \"type\": \"object\"\n }\n ]\n },\n \"package_code\": {\n \"allOf\": [\n {\n \"description\": \"A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\\n\",\n \"example\": \"small_flat_rate_box\",\n \"maxLength\": 50,\n \"minLength\": 1,\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9]+)*$\",\n \"title\": \"package_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\\n\"\n },\n \"package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\"\n },\n \"package_name\": {\n \"description\": \"The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)\",\n \"type\": \"string\"\n },\n \"products\": {\n \"default\": [],\n \"description\": \"Details about products inside packages (Information provided would be used on custom documentation)\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"The customs declaration for a single item in the shipment.\",\n \"properties\": {\n \"country_of_origin\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\\n\",\n \"nullable\": true\n },\n \"dangerous_goods\": {\n \"default\": [],\n \"description\": \"Details about dangerous goods inside products\",\n \"items\": {\n \"additionalProperties\": false,\n \"description\": \"Dangerous goods attribute associated with the product\\n\",\n \"properties\": {\n \"additional_description\": {\n \"default\": null,\n \"description\": \"Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"dangerous_amount\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"This model represents the amount of the dangerous goods..\",\n \"properties\": {\n \"amount\": {\n \"default\": 0,\n \"description\": \"The amount of dangerous goods.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"unit\": {\n \"default\": null,\n \"description\": \"The unit of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_amount\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"This model represents the amount of the dangerous goods.\"\n },\n \"id_number\": {\n \"default\": null,\n \"description\": \"UN number to identify the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_group\": {\n \"enum\": [\n \"i\",\n \"ii\",\n \"iii\"\n ],\n \"title\": \"packaging_group\",\n \"type\": \"string\"\n },\n \"packaging_instruction\": {\n \"default\": null,\n \"description\": \"The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"packaging_instruction_section\": {\n \"enum\": [\n \"section_1\",\n \"section_2\",\n \"section_1a\",\n \"section_1b\"\n ],\n \"title\": \"packaging_instruction_section\",\n \"type\": \"string\"\n },\n \"packaging_type\": {\n \"default\": null,\n \"description\": \"The type of exterior packaging used to contain the dangerous good.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class\": {\n \"default\": null,\n \"description\": \"Dangerous goods product class based on regulation.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_class_subsidiary\": {\n \"default\": null,\n \"description\": \"A secondary of product class for substances presenting more than one particular hazard\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"Quantity of dangerous goods.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"radioactive\": {\n \"description\": \"Indication if the substance is radioactive.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"regulation_authority\": {\n \"default\": null,\n \"description\": \"Name of the regulatory authority.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"regulation_level\": {\n \"enum\": [\n \"lightly_regulated\",\n \"fully_regulated\",\n \"limited_quantities\",\n \"excepted_quantity\"\n ],\n \"title\": \"regulation_level\",\n \"type\": \"string\"\n },\n \"reportable_quantity\": {\n \"description\": \"Indication if the substance needs to be reported to regulatory authority based on the quantity.\",\n \"example\": false,\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"shipping_name\": {\n \"default\": null,\n \"description\": \"Trade description of the dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"technical_name\": {\n \"default\": null,\n \"description\": \"Recognized Technical or chemical name of dangerous goods.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_category\": {\n \"default\": null,\n \"description\": \"Transport category assign to dangerous goods for the transport purpose.\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"transport_mean\": {\n \"enum\": [\n \"ground\",\n \"water\",\n \"cargo_aircraft_only\",\n \"passenger_aircraft\"\n ],\n \"title\": \"transport_mean\",\n \"type\": \"string\"\n },\n \"tunnel_code\": {\n \"default\": null,\n \"description\": \"Defines which types of tunnels the shipment is allowed to go through\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"dangerous_goods\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"description\": {\n \"default\": null,\n \"description\": \"A description of the item\",\n \"maxLength\": 100,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"extended_details\": {\n \"additionalProperties\": true,\n \"description\": \"Additional details about products\",\n \"type\": \"object\"\n },\n \"harmonized_tariff_code\": {\n \"default\": null,\n \"description\": \"The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.\",\n \"example\": 3926.1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"mid_code\": {\n \"description\": \"Manufacturers Identification code\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"product_url\": {\n \"description\": \"link to the item on the seller website\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"quantity\": {\n \"default\": 0,\n \"description\": \"The quantity of this item in the shipment.\",\n \"format\": \"int32\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sku\": {\n \"description\": \"The SKU (Stock Keeping Unit) of the item\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"sku_description\": {\n \"description\": \"Description of the Custom Item's SKU\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"unit_of_measure\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"value\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\\n\",\n \"properties\": {\n \"amount\": {\n \"description\": \"The monetary amount, in the specified currency.\",\n \"minimum\": 0,\n \"type\": \"number\"\n },\n \"currency\": {\n \"allOf\": [\n {\n \"description\": \"The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\\n\",\n \"title\": \"currency\",\n \"type\": \"string\"\n }\n ]\n }\n },\n \"required\": [\n \"currency\",\n \"amount\"\n ],\n \"title\": \"monetary_value\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The declared value of each item\"\n },\n \"vat_rate\": {\n \"description\": \"VAT rate applicable to the item\",\n \"example\": 0.2,\n \"nullable\": true,\n \"type\": \"number\"\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The item weight\"\n }\n },\n \"title\": \"products\",\n \"type\": \"object\"\n },\n \"minItems\": 0,\n \"type\": \"array\"\n },\n \"shipment_package_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies this shipment package\",\n \"readOnly\": true\n },\n \"tracking_number\": {\n \"allOf\": [\n {\n \"description\": \"A tracking number for a package. The format depends on the carrier.\",\n \"example\": \"1Z932R800392060079\",\n \"minLength\": 1,\n \"title\": \"tracking_number\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The tracking number for the package. The format depends on the carrier.\\n\",\n \"readOnly\": true\n },\n \"weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The package weight\"\n }\n },\n \"required\": [\n \"weight\"\n ],\n \"title\": \"package\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 1,\n \"type\": \"array\"\n },\n \"return_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address for this shipment. Defaults to the `ship_from` address.\\n\"\n },\n \"service_code\": {\n \"allOf\": [\n {\n \"description\": \"A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\",\n \"example\": \"usps_first_class_mail\",\n \"pattern\": \"^[a-z0-9]+(_[a-z0-9-]+)* ?$\",\n \"title\": \"service_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\\n\"\n },\n \"ship_date\": {\n \"allOf\": [\n {\n \"description\": \"An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\\n\",\n \"example\": \"2018-09-23T00:00:00.000Z\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}(T\\\\d{2}:\\\\d{2}:\\\\d{2}(\\\\.\\\\d+)?(Z|[-+]\\\\d{2}:\\\\d{2}))?$\",\n \"title\": \"date\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\\n\"\n },\n \"ship_from\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\\n\"\n },\n \"ship_to\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n },\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"geolocation\": {\n \"items\": {\n \"properties\": {\n \"type\": {\n \"description\": \"Enum of available type of geolocation items:\\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\\n\",\n \"enum\": [\n \"what3words\"\n ],\n \"example\": \"what3words\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"value of the geolocation item\",\n \"example\": \"cats.with.thumbs\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"instructions\": {\n \"description\": \"Additional text about how to handle the shipment at this address.\\n\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"title\": \"shipping_address_to\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The recipient's mailing address\"\n },\n \"shipment_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the shipment\",\n \"readOnly\": true\n },\n \"shipment_number\": {\n \"description\": \"A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\\n\\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\\n\",\n \"maxLength\": 50,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"shipment_status\": {\n \"allOf\": [\n {\n \"description\": \"The possible shipment status values\",\n \"enum\": [\n \"pending\",\n \"processing\",\n \"label_purchased\",\n \"cancelled\"\n ],\n \"title\": \"shipment_status\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"pending\",\n \"description\": \"The current status of the shipment\",\n \"readOnly\": true\n },\n \"shipping_rule_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\\n\"\n },\n \"tags\": {\n \"default\": [],\n \"description\": \"Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\\n\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\\n\",\n \"properties\": {\n \"color\": {\n \"description\": \"A hex-coded string identifying the color of the tag.\",\n \"example\": \"#FF0000\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The tag name.\",\n \"example\": \"Fragile\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"tag_id\": {\n \"description\": \"An integer uniquely identifying a tag.\",\n \"example\": 8712,\n \"format\": \"int32\",\n \"minimum\": 1,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"title\": \"tag\",\n \"type\": \"object\"\n }\n ]\n },\n \"minItems\": 0,\n \"readOnly\": true,\n \"type\": \"array\"\n },\n \"tax_identifiers\": {\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A tax identifier object\",\n \"properties\": {\n \"identifier_type\": {\n \"allOf\": [\n {\n \"description\": \"Tax identifier type for customs declaration\\n\\n|Pickup Type | Description\\n|---------------|-----------------------------------------\\n|`vat` | The tax identifier is a Value Added Tax.\\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\\n|`ssn` | The tax identifier is a Social Security Number.\\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\\n|`passport` | The tax identifier is a Passport Number.\\n|`abn` | The tax identifier is an Australian Business Number.\\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\\n\",\n \"enum\": [\n \"vat\",\n \"eori\",\n \"ssn\",\n \"ein\",\n \"tin\",\n \"ioss\",\n \"pan\",\n \"voec\",\n \"pccc\",\n \"oss\",\n \"passport\",\n \"abn\",\n \"ukims\"\n ],\n \"title\": \"identifier_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"issuing_authority\": {\n \"description\": \"The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.\",\n \"type\": \"string\"\n },\n \"taxable_entity_type\": {\n \"allOf\": [\n {\n \"description\": \"The taxable entity type for this tax item. Valid values include the following\\n\\n|Value |Description\\n|:--------- |:-----------------------------------------------------\\n|`shipper` | The shipper is responsible for this tax.\\n|`recipient` | The recipient of the shipment is responsible for this tax.\\n|`ior` | The importer of records is responsible for tax.\\n\",\n \"enum\": [\n \"shipper\",\n \"recipient\",\n \"ior\"\n ],\n \"title\": \"taxable_entity_type\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The value of the identifier\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"taxable_entity_type\",\n \"identifier_type\",\n \"issuing_authority\",\n \"value\"\n ],\n \"title\": \"tax_identifier\",\n \"type\": \"object\"\n }\n ]\n },\n \"nullable\": true,\n \"type\": \"array\"\n },\n \"total_weight\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"The weight of a package\",\n \"properties\": {\n \"unit\": {\n \"allOf\": [\n {\n \"description\": \"The possible weight unit values\",\n \"enum\": [\n \"pound\",\n \"ounce\",\n \"gram\",\n \"kilogram\"\n ],\n \"title\": \"weight_unit\",\n \"type\": \"string\"\n }\n ]\n },\n \"value\": {\n \"description\": \"The weight, in the specified unit\",\n \"exclusiveMinimum\": true,\n \"minimum\": 0,\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"value\",\n \"unit\"\n ],\n \"title\": \"weight\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The combined weight of all packages in the shipment\",\n \"readOnly\": true\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"default\": null,\n \"description\": \"The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\\n\",\n \"nullable\": true\n },\n \"zone\": {\n \"description\": \"Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\\ncustom zones that vary depending upon the ship_to and ship_from location\\n\",\n \"example\": 6,\n \"format\": \"int32\",\n \"minimum\": 0,\n \"nullable\": true,\n \"readOnly\": true,\n \"type\": \"integer\"\n }\n },\n \"title\": \"partial_shipment\",\n \"type\": \"object\"\n },\n {\n \"properties\": {\n \"validate_address\": {\n \"allOf\": [\n {\n \"description\": \"The possible validate address values\",\n \"enum\": [\n \"no_validation\",\n \"validate_only\",\n \"validate_and_clean\"\n ],\n \"title\": \"validate_address\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"no_validation\"\n }\n },\n \"title\": \"update_shipment_fields\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An update shipment request body\",\n \"required\": [\n \"ship_to\",\n \"ship_from\"\n ],\n \"title\": \"update_shipment_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"update_shipment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Shipment By ID\",\n \"tags\": [\n \"shipments\"\n ]\n },\n \"update_warehouse\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update Warehouse object information\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_warehouse\",\n \"parameters\": [\n {\n \"description\": \"Warehouse ID\",\n \"in\": \"path\",\n \"name\": \"warehouse_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/warehouses/{warehouse_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A warehouse\",\n \"properties\": {\n \"created_at\": {\n \"description\": \"Timestamp that indicates when the warehouse was created\",\n \"example\": \"2019-06-25T18:12:35.583Z\",\n \"format\": \"date-time\",\n \"minLength\": 1,\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"is_default\": {\n \"default\": false,\n \"description\": \"Designates which single warehouse is the default on the account\",\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"name\": {\n \"description\": \"Name of the warehouse\",\n \"example\": \"Zero Cool HQ\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"origin_address\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The origin address of the warehouse\"\n },\n \"return_address\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\\n\",\n \"required\": [\n \"name\",\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"postal_code\"\n ],\n \"title\": \"address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"The return address associated with the warehouse\"\n },\n \"warehouse_id\": {\n \"allOf\": [\n {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"A string that uniquely identifies the warehouse\",\n \"readOnly\": true\n }\n },\n \"title\": \"warehouse\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An update warehouse request body\",\n \"required\": [\n \"name\",\n \"origin_address\"\n ],\n \"title\": \"update_warehouse_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"update_warehouse\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Warehouse By Id\",\n \"tags\": [\n \"warehouses\"\n ]\n },\n \"update_warehouse_settings\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update Warehouse settings object information\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_warehouse_settings\",\n \"parameters\": [\n {\n \"description\": \"Warehouse ID\",\n \"in\": \"path\",\n \"name\": \"warehouse_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/warehouses/{warehouse_id}/settings\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"An update warehouse settings request body\",\n \"properties\": {\n \"is_default\": {\n \"description\": \"The default property on the warehouse.\",\n \"example\": true,\n \"nullable\": true,\n \"type\": \"boolean\"\n }\n },\n \"title\": \"update_warehouse_settings_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"update_warehouse_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update Warehouse Settings\",\n \"tags\": [\n \"warehouses\"\n ]\n },\n \"update_webhook\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update the webhook url property\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"update_webhook\",\n \"parameters\": [\n {\n \"description\": \"Webhook ID\",\n \"in\": \"path\",\n \"name\": \"webhook_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/environment/webhooks/{webhook_id}\",\n \"request_body\": {\n \"additionalProperties\": false,\n \"description\": \"An update webhook request body\",\n \"properties\": {\n \"headers\": {\n \"description\": \"Array of custom webhook headers\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"Optional header to be specified in webhook\",\n \"properties\": {\n \"key\": {\n \"description\": \"Key/name of a header\",\n \"example\": \"custom-key\",\n \"min_length\": 1,\n \"title\": \"key\",\n \"type\": \"string\"\n },\n \"value\": {\n \"description\": \"Value of a header\",\n \"example\": \"custom-value\",\n \"title\": \"value\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"key\",\n \"value\"\n ],\n \"title\": \"webhook_header\",\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"name\": {\n \"description\": \"The name of the webhook\",\n \"example\": \"My Updated Webhook\",\n \"type\": \"string\"\n },\n \"store_id\": {\n \"description\": \"Store ID\",\n \"example\": 123456,\n \"format\": \"int32\",\n \"type\": \"integer\"\n },\n \"url\": {\n \"allOf\": [\n {\n \"description\": \"A URL\",\n \"example\": \"http://api.shipengine.com/v1/labels/se-28529731\",\n \"format\": \"url\",\n \"minLength\": 1,\n \"title\": \"url\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The url that the wehbook sends the request\",\n \"example\": \"https://[YOUR ENDPOINT ID].x.requestbin.com\"\n }\n },\n \"title\": \"update_webhook_request_body\",\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"update_webhook\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Update a Webhook\",\n \"tags\": [\n \"webhooks\"\n ]\n },\n \"validate_address\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges.\\nShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"validate_address\",\n \"parameters\": [],\n \"path\": \"/v1/addresses/validate\",\n \"request_body\": {\n \"description\": \"An address validation request body\",\n \"items\": {\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"allOf\": [\n {\n \"additionalProperties\": false,\n \"description\": \"A complete or partial mailing address.\",\n \"properties\": {\n \"address_line1\": {\n \"description\": \"The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\\n\",\n \"example\": \"1999 Bishop Grandin Blvd.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"address_line2\": {\n \"description\": \"The second line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Unit 408\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_line3\": {\n \"description\": \"The third line of the street address. For some addresses, this line may not be needed.\\n\",\n \"example\": \"Building #7\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"address_residential_indicator\": {\n \"allOf\": [\n {\n \"description\": \"Indicates whether an address is residential.\",\n \"enum\": [\n \"unknown\",\n \"yes\",\n \"no\"\n ],\n \"title\": \"address_residential_indicator\",\n \"type\": \"string\"\n }\n ],\n \"default\": \"unknown\",\n \"description\": \"Indicates whether this is a residential address.\",\n \"example\": \"no\"\n },\n \"city_locality\": {\n \"description\": \"The name of the city or locality\",\n \"example\": \"Winnipeg\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"company_name\": {\n \"description\": \"If this is a business address, then the company name should be specified here.\\n\",\n \"example\": \"The Home Depot\",\n \"minLength\": 1,\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"allOf\": [\n {\n \"description\": \"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\",\n \"example\": \"CA\",\n \"maxLength\": 2,\n \"minLength\": 2,\n \"title\": \"country_code\",\n \"type\": \"string\"\n }\n ],\n \"description\": \"The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\\n\"\n },\n \"email\": {\n \"description\": \"Email for the address owner.\\n\",\n \"example\": \"example@example.com\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\\n\",\n \"example\": \"John Doe\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"phone\": {\n \"description\": \"The phone number of a contact person at this address. The format of this phone number varies depending on the country.\\n\",\n \"example\": \"+1 204-253-9411 ext. 123\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"postal_code\": {\n \"allOf\": [\n {\n \"description\": \"postal code\",\n \"example\": \"78756-3717\",\n \"minLength\": 1,\n \"title\": \"postal_code\",\n \"type\": \"string\"\n }\n ]\n },\n \"state_province\": {\n \"description\": \"The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\\n\",\n \"example\": \"Manitoba\",\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"title\": \"partial_address\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"Any residential or business mailing address, anywhere in the world.\\n\",\n \"required\": [\n \"address_line1\",\n \"city_locality\",\n \"state_province\",\n \"country_code\"\n ],\n \"title\": \"address_to_validate\",\n \"type\": \"object\"\n }\n ],\n \"description\": \"An array of addresses to validate.\"\n },\n \"title\": \"validate_address_request_body\",\n \"type\": \"array\"\n },\n \"security\": null,\n \"skill_name\": \"validate_address\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Validate An Address\",\n \"tags\": [\n \"addresses\"\n ]\n },\n \"void_label\": {\n \"base_url\": \"https://api.shipengine.com\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Void a label by ID to get a refund.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"void_label\",\n \"parameters\": [\n {\n \"description\": \"Label ID\",\n \"in\": \"path\",\n \"name\": \"label_id\",\n \"required\": true,\n \"schema\": {\n \"description\": \"A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.\",\n \"example\": \"se-28529731\",\n \"maxLength\": 25,\n \"minLength\": 1,\n \"pattern\": \"^se(-[a-z0-9]+)+$\",\n \"title\": \"se_id\",\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v1/labels/{label_id}/void\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"void_label\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json\",\n \"source_title\": \"ShipEngine API\",\n \"summary\": \"Void a Label By ID\",\n \"tags\": [\n \"labels\"\n ]\n }\n}")
|
|
OPERATION_GROUPS = json.loads("[\n {\n \"common_prefix\": \"/v1/account/settings\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /v1/account/settings for the account route group.\",\n \"id\": \"account\",\n \"label\": \"account\",\n \"operation_ids\": [\n \"list_account_settings\",\n \"list_account_images\",\n \"create_account_image\",\n \"get_account_settings_images_by_id\",\n \"update_account_settings_images_by_id\",\n \"delete_account_image_by_id\"\n ],\n \"skill_dir\": \"account\",\n \"skill_name\": \"account-routes\",\n \"skill_path\": \"skills/account/SKILL.md\",\n \"subagent_name\": \"account-api\"\n },\n {\n \"common_prefix\": \"/v1/addresses\",\n \"description\": \"Handle 2 OpenAPI operation(s) under /v1/addresses for the addresses route group.\",\n \"id\": \"addresses\",\n \"label\": \"addresses\",\n \"operation_ids\": [\n \"parse_address\",\n \"validate_address\"\n ],\n \"skill_dir\": \"addresses\",\n \"skill_name\": \"addresses-routes\",\n \"skill_path\": \"skills/addresses/SKILL.md\",\n \"subagent_name\": \"addresses-api\"\n },\n {\n \"common_prefix\": \"/v1/batches\",\n \"description\": \"Handle 10 OpenAPI operation(s) under /v1/batches for the batches route group.\",\n \"id\": \"batches\",\n \"label\": \"batches\",\n \"operation_ids\": [\n \"list_batches\",\n \"create_batch\",\n \"get_batch_by_external_id\",\n \"delete_batch\",\n \"get_batch_by_id\",\n \"update_batch\",\n \"add_to_batch\",\n \"list_batch_errors\",\n \"process_batch\",\n \"remove_from_batch\"\n ],\n \"skill_dir\": \"batches\",\n \"skill_name\": \"batches-routes\",\n \"skill_path\": \"skills/batches/SKILL.md\",\n \"subagent_name\": \"batches-api\"\n },\n {\n \"common_prefix\": \"/v1/carriers\",\n \"description\": \"Handle 7 OpenAPI operation(s) under /v1/carriers for the carriers route group.\",\n \"id\": \"carriers\",\n \"label\": \"carriers\",\n \"operation_ids\": [\n \"list_carriers\",\n \"get_carrier_by_id\",\n \"disconnect_carrier_by_id\",\n \"add_funds_to_carrier\",\n \"get_carrier_options\",\n \"list_carrier_package_types\",\n \"list_carrier_services\"\n ],\n \"skill_dir\": \"carriers\",\n \"skill_name\": \"carriers-routes\",\n \"skill_path\": \"skills/carriers/SKILL.md\",\n \"subagent_name\": \"carriers-api\"\n },\n {\n \"common_prefix\": \"/v1/connections\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /v1/connections for the connections route group.\",\n \"id\": \"connections\",\n \"label\": \"connections\",\n \"operation_ids\": [\n \"connect_carrier\",\n \"disconnect_carrier\",\n \"get_carrier_settings\",\n \"update_carrier_settings\",\n \"disconnect_insurer\",\n \"connect_insurer\"\n ],\n \"skill_dir\": \"connections\",\n \"skill_name\": \"connections-routes\",\n \"skill_path\": \"skills/connections/SKILL.md\",\n \"subagent_name\": \"connections-api\"\n },\n {\n \"common_prefix\": \"/v1/documents/combined_labels\",\n \"description\": \"Handle 1 OpenAPI operation(s) under /v1/documents/combined_labels for the documents route group.\",\n \"id\": \"documents\",\n \"label\": \"documents\",\n \"operation_ids\": [\n \"create_combined_label_document\"\n ],\n \"skill_dir\": \"documents\",\n \"skill_name\": \"documents-routes\",\n \"skill_path\": \"skills/documents/SKILL.md\",\n \"subagent_name\": \"documents-api\"\n },\n {\n \"common_prefix\": \"/v1/downloads/{dir}/{subdir}/{filename}\",\n \"description\": \"Handle 1 OpenAPI operation(s) under /v1/downloads/{dir}/{subdir}/{filename} for the downloads route group.\",\n \"id\": \"downloads\",\n \"label\": \"downloads\",\n \"operation_ids\": [\n \"download_file\"\n ],\n \"skill_dir\": \"downloads\",\n \"skill_name\": \"downloads-routes\",\n \"skill_path\": \"skills/downloads/SKILL.md\",\n \"subagent_name\": \"downloads-api\"\n },\n {\n \"common_prefix\": \"/v1/environment/webhooks\",\n \"description\": \"Handle 5 OpenAPI operation(s) under /v1/environment/webhooks for the environment route group.\",\n \"id\": \"environment\",\n \"label\": \"environment\",\n \"operation_ids\": [\n \"list_webhooks\",\n \"create_webhook\",\n \"get_webhook_by_id\",\n \"update_webhook\",\n \"delete_webhook\"\n ],\n \"skill_dir\": \"environment\",\n \"skill_name\": \"environment-routes\",\n \"skill_path\": \"skills/environment/SKILL.md\",\n \"subagent_name\": \"environment-api\"\n },\n {\n \"common_prefix\": \"/v1/insurance/shipsurance\",\n \"description\": \"Handle 2 OpenAPI operation(s) under /v1/insurance/shipsurance for the insurance route group.\",\n \"id\": \"insurance\",\n \"label\": \"insurance\",\n \"operation_ids\": [\n \"add_funds_to_insurance\",\n \"get_insurance_balance\"\n ],\n \"skill_dir\": \"insurance\",\n \"skill_name\": \"insurance-routes\",\n \"skill_path\": \"skills/insurance/SKILL.md\",\n \"subagent_name\": \"insurance-api\"\n },\n {\n \"common_prefix\": \"/v1/labels\",\n \"description\": \"Handle 11 OpenAPI operation(s) under /v1/labels for the labels route group.\",\n \"id\": \"labels\",\n \"label\": \"labels\",\n \"operation_ids\": [\n \"list_labels\",\n \"create_label\",\n \"get_label_by_external_shipment_id\",\n \"create_label_from_rate\",\n \"create_label_from_rate_shopper\",\n \"create_label_from_shipment\",\n \"get_label_by_id\",\n \"create_return_label\",\n \"get_tracking_log_from_label\",\n \"void_label\",\n \"cancel_label_refund\"\n ],\n \"skill_dir\": \"labels\",\n \"skill_name\": \"labels-routes\",\n \"skill_path\": \"skills/labels/SKILL.md\",\n \"subagent_name\": \"labels-api\"\n },\n {\n \"common_prefix\": \"/v1/manifests\",\n \"description\": \"Handle 4 OpenAPI operation(s) under /v1/manifests for the manifests route group.\",\n \"id\": \"manifests\",\n \"label\": \"manifests\",\n \"operation_ids\": [\n \"list_manifests\",\n \"create_manifest\",\n \"get_manifest_by_id\",\n \"get_manifest_request_by_id\"\n ],\n \"skill_dir\": \"manifests\",\n \"skill_name\": \"manifests-routes\",\n \"skill_path\": \"skills/manifests/SKILL.md\",\n \"subagent_name\": \"manifests-api\"\n },\n {\n \"common_prefix\": \"/v1/packages\",\n \"description\": \"Handle 5 OpenAPI operation(s) under /v1/packages for the packages route group.\",\n \"id\": \"packages\",\n \"label\": \"packages\",\n \"operation_ids\": [\n \"list_package_types\",\n \"create_package_type\",\n \"get_package_type_by_id\",\n \"update_package_type\",\n \"delete_package_type\"\n ],\n \"skill_dir\": \"packages\",\n \"skill_name\": \"packages-routes\",\n \"skill_path\": \"skills/packages/SKILL.md\",\n \"subagent_name\": \"packages-api\"\n },\n {\n \"common_prefix\": \"/v1/pickups\",\n \"description\": \"Handle 4 OpenAPI operation(s) under /v1/pickups for the pickups route group.\",\n \"id\": \"pickups\",\n \"label\": \"pickups\",\n \"operation_ids\": [\n \"list_scheduled_pickups\",\n \"schedule_pickup\",\n \"get_pickup_by_id\",\n \"delete_scheduled_pickup\"\n ],\n \"skill_dir\": \"pickups\",\n \"skill_name\": \"pickups-routes\",\n \"skill_path\": \"skills/pickups/SKILL.md\",\n \"subagent_name\": \"pickups-api\"\n },\n {\n \"common_prefix\": \"/v1/rates\",\n \"description\": \"Handle 4 OpenAPI operation(s) under /v1/rates for the rates route group.\",\n \"id\": \"rates\",\n \"label\": \"rates\",\n \"operation_ids\": [\n \"calculate_rates\",\n \"compare_bulk_rates\",\n \"estimate_rates\",\n \"get_rate_by_id\"\n ],\n \"skill_dir\": \"rates\",\n \"skill_name\": \"rates-routes\",\n \"skill_path\": \"skills/rates/SKILL.md\",\n \"subagent_name\": \"rates-api\"\n },\n {\n \"common_prefix\": \"/v1/service_points\",\n \"description\": \"Handle 2 OpenAPI operation(s) under /v1/service_points for the service points route group.\",\n \"id\": \"service_points\",\n \"label\": \"service points\",\n \"operation_ids\": [\n \"service_points_list\",\n \"service_points_get_by_id\"\n ],\n \"skill_dir\": \"service-points\",\n \"skill_name\": \"service-points-routes\",\n \"skill_path\": \"skills/service-points/SKILL.md\",\n \"subagent_name\": \"service-points-api\"\n },\n {\n \"common_prefix\": \"/v1/shipments\",\n \"description\": \"Handle 12 OpenAPI operation(s) under /v1/shipments for the shipments route group.\",\n \"id\": \"shipments\",\n \"label\": \"shipments\",\n \"operation_ids\": [\n \"list_shipments\",\n \"create_shipments\",\n \"get_shipment_by_external_id\",\n \"parse_shipment\",\n \"get_shipment_by_id\",\n \"update_shipment\",\n \"cancel_shipments\",\n \"list_shipment_rates\",\n \"shipments_update_tags\",\n \"shipments_list_tags\",\n \"tag_shipment\",\n \"untag_shipment\"\n ],\n \"skill_dir\": \"shipments\",\n \"skill_name\": \"shipments-routes\",\n \"skill_path\": \"skills/shipments/SKILL.md\",\n \"subagent_name\": \"shipments-api\"\n },\n {\n \"common_prefix\": \"/v1/tags\",\n \"description\": \"Handle 5 OpenAPI operation(s) under /v1/tags for the tags route group.\",\n \"id\": \"tags\",\n \"label\": \"tags\",\n \"operation_ids\": [\n \"list_tags\",\n \"create_tag\",\n \"create_tag_2\",\n \"delete_tag\",\n \"rename_tag\"\n ],\n \"skill_dir\": \"tags\",\n \"skill_name\": \"tags-routes\",\n \"skill_path\": \"skills/tags/SKILL.md\",\n \"subagent_name\": \"tags-api\"\n },\n {\n \"common_prefix\": \"/v1/tokens/ephemeral\",\n \"description\": \"Handle 1 OpenAPI operation(s) under /v1/tokens/ephemeral for the tokens route group.\",\n \"id\": \"tokens\",\n \"label\": \"tokens\",\n \"operation_ids\": [\n \"tokens_get_ephemeral_token\"\n ],\n \"skill_dir\": \"tokens\",\n \"skill_name\": \"tokens-routes\",\n \"skill_path\": \"skills/tokens/SKILL.md\",\n \"subagent_name\": \"tokens-api\"\n },\n {\n \"common_prefix\": \"/v1/tracking\",\n \"description\": \"Handle 3 OpenAPI operation(s) under /v1/tracking for the tracking route group.\",\n \"id\": \"tracking\",\n \"label\": \"tracking\",\n \"operation_ids\": [\n \"get_tracking_log\",\n \"start_tracking\",\n \"stop_tracking\"\n ],\n \"skill_dir\": \"tracking\",\n \"skill_name\": \"tracking-routes\",\n \"skill_path\": \"skills/tracking/SKILL.md\",\n \"subagent_name\": \"tracking-api\"\n },\n {\n \"common_prefix\": \"/v1/warehouses\",\n \"description\": \"Handle 6 OpenAPI operation(s) under /v1/warehouses for the warehouses route group.\",\n \"id\": \"warehouses\",\n \"label\": \"warehouses\",\n \"operation_ids\": [\n \"list_warehouses\",\n \"create_warehouse\",\n \"get_warehouse_by_id\",\n \"update_warehouse\",\n \"delete_warehouse\",\n \"update_warehouse_settings\"\n ],\n \"skill_dir\": \"warehouses\",\n \"skill_name\": \"warehouses-routes\",\n \"skill_path\": \"skills/warehouses/SKILL.md\",\n \"subagent_name\": \"warehouses-api\"\n }\n]")
|
|
ROOT_SECURITY = json.loads("[\n {\n \"api_key\": []\n }\n]")
|
|
SECURITY_SCHEMES = json.loads("{\n \"api_key\": {\n \"description\": \"To authenticate yourself to ShipEngine, you need to include an `API-Key` header in each API call. If you don't include a key when making an API request, or if you use an incorrect or expired key, then ShipEngine will respond with a `401 Unauthorized` error.\\n\\nLearn more about API keys in our [authentication guide](https://www.shipengine.com/docs/auth/).\\n\",\n \"in\": \"header\",\n \"name\": \"API-Key\",\n \"type\": \"apiKey\"\n }\n}")
|
|
SECURITY_FIELDS = json.loads("{\n \"api_key\": {\n \"field\": \"API_KEY\",\n \"kind\": \"apiKey\",\n \"location\": \"header\",\n \"name\": \"API-Key\"\n }\n}")
|
|
PATH_PARAMETER_RE = re.compile(r"{([^}/]+)}")
|
|
SOURCE_ROOT = Path(globals().get("__file__", "agent.py")).resolve().parent
|
|
SOURCE_SKILLS_DIR = SOURCE_ROOT / "skills"
|
|
RUNTIME_SKILLS_DIR = ".deepagents/openapi-skills/"
|
|
|
|
|
|
class OperationInput(BaseModel):
|
|
parameters: dict[str, Any] = Field(
|
|
default_factory=dict,
|
|
description="Path, query, header, and cookie parameters keyed by OpenAPI parameter name.",
|
|
)
|
|
body: Any | None = Field(default=None, description="JSON request body, when the operation accepts one.")
|
|
|
|
|
|
class ShipengineOpenapiAgent(A2AAgent):
|
|
name = "shipengine-openapi-agent"
|
|
description = "Shipping and logistics API for labels, rates, tracking, address validation, and carrier integrations."
|
|
version = "1.1.202604070904"
|
|
consumer_setup = ConsumerSetup.from_fields(
|
|
ConsumerSetupField.config("OPENAPI_BASE_URL", label="API base URL", description="Override the default API server (https://api.shipengine.com).", required=False, input_type="url"),
|
|
ConsumerSetupField.secret("API_KEY", label="api_key API key", description="To authenticate yourself to ShipEngine, you need to include an `API-Key` header in each API call. If you don't include a key when making an API request, or if you use an incorrect or expired key, then ShipEngine will respond with a `401 Unauthorized` error.\n\nLearn more about API keys in our [authentication guide](https://www.shipengine.com/docs/auth/).", required=True),
|
|
)
|
|
llm_provisioning = LLMProvisioning.PLATFORM
|
|
pricing = Pricing(
|
|
price_per_call_usd=0.0,
|
|
caller_pays_llm=True,
|
|
notes="Uses the caller's saved LLM credential through ctx.llm.",
|
|
)
|
|
resources = Resources(cpu="200m", memory="512Mi")
|
|
egress = EgressPolicy(
|
|
allow_hosts=('api.shipengine.com',),
|
|
deny_internet_by_default=True,
|
|
)
|
|
tools_used = ("openapi", "deepagents")
|
|
capabilities = {
|
|
"openapi_auto_agent": {
|
|
"operation_count": len(OPERATIONS),
|
|
"default_base_url": DEFAULT_BASE_URL,
|
|
"source_openapi_url": 'https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json',
|
|
"source_openapi_urls": ['https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json'],
|
|
"server_urls": ['https://api.shipengine.com'],
|
|
"regenerable": True,
|
|
"security_schemes": list(SECURITY_SCHEMES),
|
|
}
|
|
}
|
|
|
|
@skill(
|
|
name="auto",
|
|
description="Use the OpenAPI service to complete a natural-language goal.",
|
|
tags=("openapi", "auto"),
|
|
timeout_seconds=900,
|
|
)
|
|
async def auto(self, ctx: RunContext, goal: str) -> dict[str, Any]:
|
|
creds = ctx.llm
|
|
if not creds.api_key:
|
|
return {
|
|
"error": "llm_credentials_missing",
|
|
"final": (
|
|
"LLM key required. Add an LLM credential in Settings > "
|
|
"LLM credentials before running this agent."
|
|
),
|
|
"messages": [],
|
|
}
|
|
backend = ctx.workspace_backend()
|
|
skills_root = _seed_runtime_skills(backend, ctx)
|
|
graph = create_a2a_deep_agent(
|
|
ctx,
|
|
creds=creds,
|
|
backend=backend,
|
|
tools=[],
|
|
subagents=self._operation_subagents(ctx, skills_root),
|
|
system_prompt=self._system_prompt(),
|
|
)
|
|
result = await graph.ainvoke({"messages": [{"role": "user", "content": goal}]})
|
|
messages = result.get("messages", []) if isinstance(result, dict) else []
|
|
final = _message_text(messages[-1]) if messages else result
|
|
return {
|
|
"final": final,
|
|
"messages": [_message_to_dict(message) for message in messages[-8:]],
|
|
}
|
|
|
|
|
|
|
|
def _operation_subagents(self, ctx: RunContext, skills_root: str) -> list[dict[str, Any]]:
|
|
subagents: list[dict[str, Any]] = []
|
|
for group in OPERATION_GROUPS:
|
|
skill_path = (
|
|
f"{skills_root}{group['skill_dir']}/"
|
|
if skills_root
|
|
else ""
|
|
)
|
|
subagent = {
|
|
"name": group["subagent_name"],
|
|
"description": group["description"],
|
|
"system_prompt": self._subagent_prompt(group),
|
|
"tools": self._operation_tools(ctx, set(group["operation_ids"])),
|
|
}
|
|
if skill_path:
|
|
subagent["skills"] = [skill_path]
|
|
subagents.append(subagent)
|
|
return subagents
|
|
|
|
def _operation_tools(
|
|
self,
|
|
ctx: RunContext,
|
|
operation_ids: set[str] | None = None,
|
|
) -> list[StructuredTool]:
|
|
tools: list[StructuredTool] = []
|
|
for operation_id, operation in OPERATIONS.items():
|
|
if operation_ids is not None and operation_id not in operation_ids:
|
|
continue
|
|
async def call(
|
|
parameters: dict[str, Any] | None = None,
|
|
body: Any | None = None,
|
|
*,
|
|
_operation_id: str = operation_id,
|
|
) -> dict[str, Any]:
|
|
return await self._request(
|
|
ctx,
|
|
_operation_id,
|
|
parameters=parameters or {},
|
|
body=body,
|
|
)
|
|
|
|
tools.append(
|
|
StructuredTool.from_function(
|
|
coroutine=call,
|
|
name=operation["skill_name"],
|
|
description=self._tool_description(operation),
|
|
args_schema=OperationInput,
|
|
)
|
|
)
|
|
return tools
|
|
|
|
def _system_prompt(self) -> str:
|
|
if OPERATION_GROUPS:
|
|
lines = [
|
|
"You coordinate route-specific OpenAPI subagents.",
|
|
"Delegate API work to the matching subagent with the task tool.",
|
|
"Do not invent API responses; ask subagents to call their tools for real results.",
|
|
"If a subagent reports missing consumer setup, tell the user which setup field is required.",
|
|
"If a subagent reports that the generated OpenAPI agent may be stale, ask whether the user wants to refresh it from the latest OpenAPI spec.",
|
|
"",
|
|
"Available route groups:",
|
|
]
|
|
for group in OPERATION_GROUPS:
|
|
lines.append(
|
|
f"- {group['subagent_name']}: {group['description']}"
|
|
)
|
|
return "\n".join(lines)
|
|
lines = [
|
|
"You operate an API through generated OpenAPI tools.",
|
|
"Call tools to get real results. Do not invent API responses.",
|
|
"For write, update, or delete operations, explain the intended action before calling the tool.",
|
|
"If an operation reports missing consumer setup, tell the user which setup field is required.",
|
|
"If an operation returns 404, 405, 410, or a schema/validation error that suggests the live API no longer matches these tools, tell the user this generated agent may need to be refreshed from the latest OpenAPI spec and ask whether they want to refresh it.",
|
|
"",
|
|
"Available operations:",
|
|
]
|
|
for operation in OPERATIONS.values():
|
|
marker = "WRITE" if operation.get("destructive") else "READ"
|
|
lines.append(
|
|
f"- {operation['skill_name']}: {marker} {operation['method']} {operation['path']} — {operation['summary']}"
|
|
)
|
|
return "\n".join(lines)
|
|
|
|
def _subagent_prompt(self, group: dict[str, Any]) -> str:
|
|
lines = [
|
|
"You operate one route group from a generated OpenAPI API.",
|
|
"Use the available operation tools to make real API calls. Do not invent API responses.",
|
|
"Read the route group's SKILL.md when it applies; it lists every route you cover.",
|
|
"For write, update, or delete operations, explain the intended action before calling the tool.",
|
|
"If an operation reports missing consumer setup, return the exact setup field name.",
|
|
"If an operation returns 404, 405, 410, or a schema/validation error that suggests the live API no longer matches these tools, say the generated agent may need to be refreshed from the latest OpenAPI spec.",
|
|
"",
|
|
f"Route group: {group['label']}",
|
|
f"Common prefix: {group.get('common_prefix') or '/'}",
|
|
"Available operation tools:",
|
|
]
|
|
for operation_id in group["operation_ids"]:
|
|
operation = OPERATIONS[operation_id]
|
|
marker = "WRITE" if operation.get("destructive") else "READ"
|
|
lines.append(
|
|
f"- {operation['skill_name']}: {marker} {operation['method']} {operation['path']} - {operation['summary']}"
|
|
)
|
|
return "\n".join(lines)
|
|
|
|
def _tool_description(self, operation: dict[str, Any]) -> str:
|
|
parts = [
|
|
f"{operation['method']} {operation['path']}",
|
|
str(operation.get("description") or operation.get("summary") or ""),
|
|
]
|
|
if operation.get("parameters"):
|
|
parts.append(
|
|
"Parameters: "
|
|
+ ", ".join(
|
|
f"{p['name']} in {p['in']}{' required' if p.get('required') else ''}"
|
|
for p in operation["parameters"]
|
|
)
|
|
)
|
|
if operation.get("request_body") is not None:
|
|
parts.append("Accepts a JSON request body.")
|
|
return "\n".join(part for part in parts if part)
|
|
|
|
async def _request(
|
|
self,
|
|
ctx: RunContext,
|
|
operation_id: str,
|
|
*,
|
|
parameters: dict[str, Any],
|
|
body: Any | None,
|
|
) -> dict[str, Any]:
|
|
operation = OPERATIONS[operation_id]
|
|
default_base_url = str(operation.get("base_url") or DEFAULT_BASE_URL).rstrip("/")
|
|
base_url_field = str(operation.get("base_url_field") or "OPENAPI_BASE_URL")
|
|
base_url = str(ctx.consumer_config(base_url_field, default_base_url) or default_base_url).rstrip("/")
|
|
url, query, headers = self._request_parts(ctx, operation, parameters)
|
|
request_kwargs: dict[str, Any] = {
|
|
"params": query,
|
|
"headers": headers,
|
|
}
|
|
if body is not None:
|
|
if isinstance(body, (bytes, bytearray)):
|
|
body = body.decode("utf-8", errors="replace")
|
|
if isinstance(body, str):
|
|
stripped = body.strip()
|
|
if stripped and stripped[0] in "{[":
|
|
try:
|
|
body = json.loads(stripped)
|
|
except ValueError:
|
|
pass
|
|
request_kwargs["json"] = body
|
|
async with httpx.AsyncClient(timeout=60.0, follow_redirects=True) as client:
|
|
response = await client.request(
|
|
operation["method"],
|
|
f"{base_url}{url}",
|
|
**request_kwargs,
|
|
)
|
|
content_type = response.headers.get("content-type", "")
|
|
try:
|
|
payload: Any = response.json() if "json" in content_type else response.text
|
|
except ValueError:
|
|
payload = response.text
|
|
if response.status_code >= 400:
|
|
out = {
|
|
"ok": False,
|
|
"status_code": response.status_code,
|
|
"operation_id": operation_id,
|
|
"error": payload,
|
|
}
|
|
if response.status_code in {404, 405, 410, 422}:
|
|
out["stale_openapi_hint"] = (
|
|
"This generated OpenAPI agent may be stale. Ask the user "
|
|
"whether they want to refresh it from the latest OpenAPI spec."
|
|
)
|
|
return out
|
|
return {
|
|
"ok": True,
|
|
"status_code": response.status_code,
|
|
"operation_id": operation_id,
|
|
"result": payload,
|
|
}
|
|
|
|
def _request_parts(
|
|
self,
|
|
ctx: RunContext,
|
|
operation: dict[str, Any],
|
|
parameters: dict[str, Any],
|
|
) -> tuple[str, dict[str, Any], dict[str, str]]:
|
|
path = operation["path"]
|
|
query: dict[str, Any] = {}
|
|
headers: dict[str, str] = {}
|
|
cookies: dict[str, Any] = {}
|
|
for param in operation.get("parameters") or []:
|
|
name = param["name"]
|
|
if name not in parameters:
|
|
if param.get("required"):
|
|
raise ValueError(f"missing required parameter {name!r}")
|
|
continue
|
|
value = parameters[name]
|
|
location = param["in"]
|
|
if location == "path":
|
|
path = path.replace("{" + name + "}", str(value))
|
|
elif location == "query":
|
|
query[name] = value
|
|
elif location == "header":
|
|
headers[name] = str(value)
|
|
elif location == "cookie":
|
|
cookies[name] = value
|
|
unresolved = PATH_PARAMETER_RE.findall(path)
|
|
if unresolved:
|
|
missing = ", ".join(sorted(set(unresolved)))
|
|
raise ValueError("missing required path parameter(s): " + missing)
|
|
if cookies:
|
|
headers["cookie"] = "; ".join(f"{key}={value}" for key, value in cookies.items())
|
|
auth_headers, auth_query = self._auth_for_operation(ctx, operation)
|
|
headers.update(auth_headers)
|
|
query.update(auth_query)
|
|
return path, query, headers
|
|
|
|
def _auth_for_operation(self, ctx: RunContext, operation: dict[str, Any]) -> tuple[dict[str, str], dict[str, Any]]:
|
|
requirements = operation.get("security")
|
|
if requirements is None:
|
|
requirements = ROOT_SECURITY
|
|
if requirements == []:
|
|
return {}, {}
|
|
missing: list[str] = []
|
|
for requirement in requirements or []:
|
|
if not isinstance(requirement, dict) or not requirement:
|
|
return {}, {}
|
|
headers: dict[str, str] = {}
|
|
query: dict[str, Any] = {}
|
|
ok = True
|
|
for scheme_name in requirement:
|
|
mapping = SECURITY_FIELDS.get(scheme_name) or {}
|
|
secret_name = mapping.get("field")
|
|
value = _consumer_secret_optional(ctx, secret_name) if secret_name else ""
|
|
if not value:
|
|
ok = False
|
|
if secret_name:
|
|
missing.append(secret_name)
|
|
continue
|
|
kind = mapping.get("kind")
|
|
if kind == "apiKey":
|
|
prefix = mapping.get("prefix") or ""
|
|
sent_value = f"{prefix}{value}"
|
|
if mapping.get("location") == "query":
|
|
query[mapping.get("name") or scheme_name] = sent_value
|
|
else:
|
|
headers[mapping.get("name") or scheme_name] = sent_value
|
|
elif kind in {"http", "oauth2"}:
|
|
scheme = mapping.get("scheme") or "Bearer"
|
|
if scheme.lower() == "basic":
|
|
token = base64.b64encode(value.encode("utf-8")).decode("ascii")
|
|
headers["authorization"] = f"Basic {token}"
|
|
else:
|
|
headers["authorization"] = f"{scheme} {value}"
|
|
else:
|
|
ok = False
|
|
if ok:
|
|
return headers, query
|
|
if missing:
|
|
raise ConsumerSetupMissing(
|
|
"operation requires consumer setup secret(s): "
|
|
+ ", ".join(sorted(set(missing)))
|
|
)
|
|
return {}, {}
|
|
|
|
|
|
def _consumer_secret_optional(ctx: RunContext, name: str | None) -> str:
|
|
if not name:
|
|
return ""
|
|
try:
|
|
return ctx.consumer_secret(name)
|
|
except ConsumerSetupMissing:
|
|
return ""
|
|
|
|
|
|
def _runtime_skills_root(ctx: RunContext) -> str:
|
|
workspace = getattr(ctx, "_workspace", None)
|
|
prefixes = tuple(getattr(workspace, "write_prefixes", ()) or ())
|
|
if not prefixes:
|
|
outputs_prefix = getattr(workspace, "outputs_prefix", None)
|
|
prefixes = (outputs_prefix or "outputs/",)
|
|
prefix = str(prefixes[0]).strip("/")
|
|
return f"/{prefix}/{RUNTIME_SKILLS_DIR}" if prefix else f"/{RUNTIME_SKILLS_DIR}"
|
|
|
|
|
|
def _seed_runtime_skills(backend: Any, ctx: RunContext) -> str:
|
|
if not SOURCE_SKILLS_DIR.exists():
|
|
return ""
|
|
runtime_root = _runtime_skills_root(ctx)
|
|
uploads: list[tuple[str, bytes]] = []
|
|
for path in SOURCE_SKILLS_DIR.rglob("*"):
|
|
if not path.is_file():
|
|
continue
|
|
rel = path.relative_to(SOURCE_SKILLS_DIR).as_posix()
|
|
uploads.append((runtime_root + rel, path.read_bytes()))
|
|
if not uploads:
|
|
return ""
|
|
backend.upload_files(uploads)
|
|
return runtime_root
|
|
|
|
|
|
def _message_text(message: Any) -> Any:
|
|
content = getattr(message, "content", message)
|
|
return content
|
|
|
|
|
|
def _message_to_dict(message: Any) -> dict[str, Any]:
|
|
if isinstance(message, BaseMessage):
|
|
return message.model_dump(mode="json")
|
|
if hasattr(message, "model_dump"):
|
|
return message.model_dump(mode="json")
|
|
if isinstance(message, dict):
|
|
return message
|
|
return {"content": str(message)}
|
|
|
|
|
|
agent = ShipengineOpenapiAgent()
|